sched/doc: Update documentation for base_slice_ns and CONFIG_HZ relation
[sfrench/cifs-2.6.git] / tools / verification / rv / Makefile
1 NAME    :=      rv
2 # Follow the kernel version
3 VERSION :=      $(shell cat VERSION 2> /dev/null || make -sC ../../.. kernelversion | grep -v make)
4
5 # From libtracefs:
6 # Makefiles suck: This macro sets a default value of $(2) for the
7 # variable named by $(1), unless the variable has been set by
8 # environment or command line. This is necessary for CC and AR
9 # because make sets default values, so the simpler ?= approach
10 # won't work as expected.
11 define allow-override
12   $(if $(or $(findstring environment,$(origin $(1))),\
13             $(findstring command line,$(origin $(1)))),,\
14     $(eval $(1) = $(2)))
15 endef
16
17 # Allow setting CC and AR, or setting CROSS_COMPILE as a prefix.
18 $(call allow-override,CC,$(CROSS_COMPILE)gcc)
19 $(call allow-override,AR,$(CROSS_COMPILE)ar)
20 $(call allow-override,STRIP,$(CROSS_COMPILE)strip)
21 $(call allow-override,PKG_CONFIG,pkg-config)
22 $(call allow-override,LD_SO_CONF_PATH,/etc/ld.so.conf.d/)
23 $(call allow-override,LDCONFIG,ldconfig)
24
25 INSTALL =       install
26 MKDIR   =       mkdir
27 FOPTS   :=      -flto=auto -ffat-lto-objects -fexceptions -fstack-protector-strong \
28                 -fasynchronous-unwind-tables -fstack-clash-protection
29 WOPTS   :=      -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -Wp,-D_GLIBCXX_ASSERTIONS -Wno-maybe-uninitialized
30
31 ifeq ($(CC),clang)
32   FOPTS := $(filter-out -ffat-lto-objects, $(FOPTS))
33   WOPTS := $(filter-out -Wno-maybe-uninitialized, $(WOPTS))
34 endif
35
36 TRACEFS_HEADERS := $$($(PKG_CONFIG) --cflags libtracefs)
37
38 CFLAGS  :=      -O -g -DVERSION=\"$(VERSION)\" $(FOPTS) $(MOPTS) $(WOPTS) $(TRACEFS_HEADERS) $(EXTRA_CFLAGS) -I include
39 LDFLAGS :=      -flto=auto -ggdb $(EXTRA_LDFLAGS)
40 LIBS    :=      $$($(PKG_CONFIG) --libs libtracefs)
41
42 SRC     :=      $(wildcard src/*.c)
43 HDR     :=      $(wildcard src/*.h)
44 OBJ     :=      $(SRC:.c=.o)
45 DIRS    :=      src
46 FILES   :=      Makefile README.txt
47 CEXT    :=      bz2
48 TARBALL :=      $(NAME)-$(VERSION).tar.$(CEXT)
49 TAROPTS :=      -cvjf $(TARBALL)
50 BINDIR  :=      /usr/bin
51 DATADIR :=      /usr/share
52 DOCDIR  :=      $(DATADIR)/doc
53 MANDIR  :=      $(DATADIR)/man
54 LICDIR  :=      $(DATADIR)/licenses
55 SRCTREE :=      $(or $(BUILD_SRC),$(CURDIR))
56
57 # If running from the tarball, man pages are stored in the Documentation
58 # dir. If running from the kernel source, man pages are stored in
59 # Documentation/tools/rv/.
60 ifneq ($(wildcard Documentation/.*),)
61 DOCSRC  =       Documentation/
62 else
63 DOCSRC  =       $(SRCTREE)/../../../Documentation/tools/rv/
64 endif
65
66 LIBTRACEEVENT_MIN_VERSION = 1.5
67 LIBTRACEFS_MIN_VERSION = 1.3
68
69 .PHONY: all warnings show_warnings
70 all:    warnings rv
71
72 TEST_LIBTRACEEVENT = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEEVENT_MIN_VERSION) libtraceevent > /dev/null 2>&1 || echo n")
73 ifeq ("$(TEST_LIBTRACEEVENT)", "n")
74 WARNINGS = show_warnings
75 MISSING_LIBS += echo "**   libtraceevent version $(LIBTRACEEVENT_MIN_VERSION) or higher";
76 MISSING_PACKAGES += "libtraceevent-devel"
77 MISSING_SOURCE += echo "**  https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/ ";
78 endif
79
80 TEST_LIBTRACEFS = $(shell sh -c "$(PKG_CONFIG) --atleast-version $(LIBTRACEFS_MIN_VERSION) libtracefs > /dev/null 2>&1 || echo n")
81 ifeq ("$(TEST_LIBTRACEFS)", "n")
82 WARNINGS = show_warnings
83 MISSING_LIBS += echo "**   libtracefs version $(LIBTRACEFS_MIN_VERSION) or higher";
84 MISSING_PACKAGES += "libtracefs-devel"
85 MISSING_SOURCE += echo "**  https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/ ";
86 endif
87
88 define show_dependencies
89         @echo "********************************************";                           \
90         echo "** NOTICE: Failed build dependencies";                                    \
91         echo "**";                                                                      \
92         echo "** Required Libraries:";                                                  \
93         $(MISSING_LIBS)                                                                 \
94         echo "**";                                                                      \
95         echo "** Consider installing the latest libtracefs from your";                  \
96         echo "** distribution, e.g., 'dnf install $(MISSING_PACKAGES)' on Fedora,";     \
97         echo "** or from source:";                                                      \
98         echo "**";                                                                      \
99         $(MISSING_SOURCE)                                                               \
100         echo "**";                                                                      \
101         echo "********************************************"
102 endef
103
104 show_warnings:
105         $(call show_dependencies);
106
107 ifneq ("$(WARNINGS)", "")
108 ERROR_OUT = $(error Please add the necessary dependencies)
109
110 warnings: $(WARNINGS)
111         $(ERROR_OUT)
112 endif
113
114 rv: $(OBJ)
115         $(CC) -o rv $(LDFLAGS) $(OBJ) $(LIBS)
116
117 .PHONY: install
118 install: doc_install
119         $(MKDIR) -p $(DESTDIR)$(BINDIR)
120         $(INSTALL) rv -m 755 $(DESTDIR)$(BINDIR)
121         $(STRIP) $(DESTDIR)$(BINDIR)/rv
122
123 .PHONY: clean tarball
124 clean: doc_clean
125         @test ! -f rv || rm rv
126         @test ! -f $(TARBALL) || rm -f $(TARBALL)
127         @rm -rf *~ $(OBJ) *.tar.$(CEXT)
128
129 tarball: clean
130         rm -rf $(NAME)-$(VERSION) && mkdir $(NAME)-$(VERSION)
131         echo $(VERSION) > $(NAME)-$(VERSION)/VERSION
132         cp -r $(DIRS) $(FILES) $(NAME)-$(VERSION)
133         mkdir $(NAME)-$(VERSION)/Documentation/
134         cp -rp $(SRCTREE)/../../../Documentation/tools/rv/* $(NAME)-$(VERSION)/Documentation/
135         tar $(TAROPTS) --exclude='*~' $(NAME)-$(VERSION)
136         rm -rf $(NAME)-$(VERSION)
137
138 .PHONY: doc doc_clean doc_install
139 doc:
140         $(MAKE) -C $(DOCSRC)
141
142 doc_clean:
143         $(MAKE) -C $(DOCSRC) clean
144
145 doc_install:
146         $(MAKE) -C $(DOCSRC) install