mancheck: accept lints, accept lint overrides
[zfs.git] / Makefile.am
blob4e7e29589fc0e8f4257ebe0def304d3c37ed5826
1 include $(top_srcdir)/config/Shellcheck.am
3 ACLOCAL_AMFLAGS = -I config
5 SUBDIRS = include
6 if BUILD_LINUX
7 SUBDIRS += rpm
8 endif
10 if CONFIG_USER
11 SUBDIRS += man scripts lib tests cmd etc contrib
12 if BUILD_LINUX
13 SUBDIRS += udev
14 endif
15 endif
16 if CONFIG_KERNEL
17 SUBDIRS += module
19 extradir = $(prefix)/src/zfs-$(VERSION)
20 extra_HEADERS = zfs.release.in zfs_config.h.in
22 if BUILD_LINUX
23 kerneldir = $(prefix)/src/zfs-$(VERSION)/$(LINUX_VERSION)
24 nodist_kernel_HEADERS = zfs.release zfs_config.h module/$(LINUX_SYMBOLS)
25 endif
26 endif
28 AUTOMAKE_OPTIONS = foreign
29 EXTRA_DIST  = autogen.sh copy-builtin
30 EXTRA_DIST += config/config.awk config/rpm.am config/deb.am config/tgz.am
31 EXTRA_DIST += AUTHORS CODE_OF_CONDUCT.md COPYRIGHT LICENSE META NEWS NOTICE
32 EXTRA_DIST += README.md RELEASES.md
33 EXTRA_DIST += module/lua/README.zfs module/os/linux/spl/README.md
35 # Include all the extra licensing information for modules
36 EXTRA_DIST += module/icp/algs/skein/THIRDPARTYLICENSE
37 EXTRA_DIST += module/icp/algs/skein/THIRDPARTYLICENSE.descrip
38 EXTRA_DIST += module/icp/asm-x86_64/aes/THIRDPARTYLICENSE.gladman
39 EXTRA_DIST += module/icp/asm-x86_64/aes/THIRDPARTYLICENSE.gladman.descrip
40 EXTRA_DIST += module/icp/asm-x86_64/aes/THIRDPARTYLICENSE.openssl
41 EXTRA_DIST += module/icp/asm-x86_64/aes/THIRDPARTYLICENSE.openssl.descrip
42 EXTRA_DIST += module/icp/asm-x86_64/modes/THIRDPARTYLICENSE.cryptogams
43 EXTRA_DIST += module/icp/asm-x86_64/modes/THIRDPARTYLICENSE.cryptogams.descrip
44 EXTRA_DIST += module/icp/asm-x86_64/modes/THIRDPARTYLICENSE.openssl
45 EXTRA_DIST += module/icp/asm-x86_64/modes/THIRDPARTYLICENSE.openssl.descrip
46 EXTRA_DIST += module/os/linux/spl/THIRDPARTYLICENSE.gplv2
47 EXTRA_DIST += module/os/linux/spl/THIRDPARTYLICENSE.gplv2.descrip
48 EXTRA_DIST += module/zfs/THIRDPARTYLICENSE.cityhash
49 EXTRA_DIST += module/zfs/THIRDPARTYLICENSE.cityhash.descrip
51 @CODE_COVERAGE_RULES@
53 GITREV = include/zfs_gitrev.h
55 PHONY = gitrev
56 gitrev:
57         $(AM_V_GEN)$(top_srcdir)/scripts/make_gitrev.sh $(GITREV)
59 all: gitrev
61 # Double-colon rules are allowed; there are multiple independent definitions.
62 maintainer-clean-local::
63         -$(RM) $(GITREV)
65 distclean-local::
66         -$(RM) -R autom4te*.cache build
67         -find . \( -name SCCS -o -name BitKeeper -o -name .svn -o -name CVS \
68                 -o -name .pc -o -name .hg -o -name .git \) -prune -o \
69                 \( -name '*.orig' -o -name '*.rej' -o -name '*~' \
70                 -o -name '*.bak' -o -name '#*#' -o -name '.*.orig' \
71                 -o -name '.*.rej' -o -size 0 -o -name '*%' -o -name '.*.cmd' \
72                 -o -name 'core' -o -name 'Makefile' -o -name 'Module.symvers' \
73                 -o -name '*.order' -o -name '*.markers' -o -name '*.gcda' \
74                 -o -name '*.gcno' \) \
75                 -type f -print | xargs $(RM)
77 all-local:
78         -[ -x ${top_builddir}/scripts/zfs-tests.sh ] && \
79             ${top_builddir}/scripts/zfs-tests.sh -c
81 dist-hook:
82         $(AM_V_GEN)$(top_srcdir)/scripts/make_gitrev.sh -D $(distdir) $(GITREV)
83         $(SED) ${ac_inplace} -e 's/Release:[[:print:]]*/Release:      $(RELEASE)/' \
84                 $(distdir)/META
86 if BUILD_LINUX
87 # For compatibility, create a matching spl-x.y.z directly which contains
88 # symlinks to the updated header and object file locations.  These
89 # compatibility links will be removed in the next major release.
90 if CONFIG_KERNEL
91 install-data-hook:
92         rm -rf $(DESTDIR)$(prefix)/src/spl-$(VERSION) && \
93         mkdir $(DESTDIR)$(prefix)/src/spl-$(VERSION) && \
94         cd $(DESTDIR)$(prefix)/src/spl-$(VERSION) && \
95         ln -s ../zfs-$(VERSION)/include/spl include && \
96         ln -s ../zfs-$(VERSION)/$(LINUX_VERSION) $(LINUX_VERSION) && \
97         ln -s ../zfs-$(VERSION)/zfs_config.h.in spl_config.h.in && \
98         ln -s ../zfs-$(VERSION)/zfs.release.in spl.release.in && \
99         cd $(DESTDIR)$(prefix)/src/zfs-$(VERSION)/$(LINUX_VERSION) && \
100         ln -fs zfs_config.h spl_config.h && \
101         ln -fs zfs.release spl.release
102 endif
103 endif
105 PHONY += codecheck
106 codecheck: cstyle shellcheck checkbashisms flake8 mancheck testscheck vcscheck
108 PHONY += checkstyle
109 checkstyle: codecheck commitcheck
111 PHONY += commitcheck
112 commitcheck:
113         @if git rev-parse --git-dir > /dev/null 2>&1; then \
114                 ${top_srcdir}/scripts/commitcheck.sh; \
115         fi
117 PHONY += cstyle
118 cstyle:
119         @find ${top_srcdir} -name build -prune \
120                 -o -type f -name '*.[hc]' \
121                 ! -name 'zfs_config.*' ! -name '*.mod.c' \
122                 ! -name 'opt_global.h' ! -name '*_if*.h' \
123                 ! -path './module/zstd/lib/*' \
124                 -exec ${top_srcdir}/scripts/cstyle.pl -cpP {} \+
126 filter_executable = -exec test -x '{}' \; -print
128 SHELLCHECKDIRS = cmd contrib etc scripts tests
129 SHELLCHECKSCRIPTS = autogen.sh
131 PHONY += checkabi storeabi
132 checkabi: lib
133         $(MAKE) -C lib checkabi
135 storeabi: lib
136         $(MAKE) -C lib storeabi
138 PHONY += mancheck
139 mancheck:
140         ${top_srcdir}/scripts/mancheck.sh ${top_srcdir}/man ${top_srcdir}/tests/test-runner/man
142 if BUILD_LINUX
143 stat_fmt = -c '%A %n'
144 else
145 stat_fmt = -f '%Sp %N'
146 endif
148 PHONY += testscheck
149 testscheck:
150         @find ${top_srcdir}/tests/zfs-tests -type f \
151                 \( -name '*.ksh' -not ${filter_executable} \) -o \
152                 \( -name '*.kshlib' ${filter_executable} \) -o \
153                 \( -name '*.shlib' ${filter_executable} \) -o \
154                 \( -name '*.cfg' ${filter_executable} \) | \
155                 xargs -r stat ${stat_fmt} | \
156                 awk '{c++; print} END {if(c>0) exit 1}'
158 PHONY += vcscheck
159 vcscheck:
160         @if git rev-parse --git-dir > /dev/null 2>&1; then \
161                 git ls-files . --exclude-standard --others | \
162                 awk '{c++; print} END {if(c>0) exit 1}' ; \
163         fi
165 PHONY += lint
166 lint: cppcheck paxcheck
168 CPPCHECKDIRS = cmd lib module
169 PHONY += cppcheck
170 cppcheck: $(CPPCHECKDIRS)
171         @if test -n "$(CPPCHECK)"; then \
172                 set -e ; for dir in $(CPPCHECKDIRS) ; do \
173                         $(MAKE) -C $$dir cppcheck ; \
174                 done \
175         else \
176                 echo "skipping cppcheck because cppcheck is not installed"; \
177         fi
179 PHONY += paxcheck
180 paxcheck:
181         @if type scanelf > /dev/null 2>&1; then \
182                 ${top_srcdir}/scripts/paxcheck.sh ${top_builddir}; \
183         else \
184                 echo "skipping paxcheck because scanelf is not installed"; \
185         fi
187 PHONY += flake8
188 flake8:
189         @if type flake8 > /dev/null 2>&1; then \
190                 flake8 ${top_srcdir}; \
191         else \
192                 echo "skipping flake8 because flake8 is not installed"; \
193         fi
195 PHONY += ctags
196 ctags:
197         $(RM) tags
198         find $(top_srcdir) -name '.?*' -prune \
199                 -o -type f -name '*.[hcS]' -print | xargs ctags -a
201 PHONY += etags
202 etags:
203         $(RM) TAGS
204         find $(top_srcdir) -name '.?*' -prune \
205                 -o -type f -name '*.[hcS]' -print | xargs etags -a
207 PHONY += cscopelist
208 cscopelist:
209         find $(top_srcdir) -name '.?*' -prune \
210                 -o -type f -name '*.[hc]' -print >cscope.files
212 PHONY += tags
213 tags: ctags etags
215 PHONY += pkg pkg-dkms pkg-kmod pkg-utils
216 pkg: @DEFAULT_PACKAGE@
217 pkg-dkms: @DEFAULT_PACKAGE@-dkms
218 pkg-kmod: @DEFAULT_PACKAGE@-kmod
219 pkg-utils: @DEFAULT_PACKAGE@-utils
221 include config/rpm.am
222 include config/deb.am
223 include config/tgz.am
225 .PHONY: $(PHONY)