syntax-check: Fix typo.
[gnulib.git] / Makefile
1 # GNU Makefile for gnulib central.
2 # Copyright (C) 2006, 2009-2011 Free Software Foundation, Inc.
3 #
4 # Copying and distribution of this file, with or without modification,
5 # in any medium, are permitted without royalty provided the copyright
6 # notice and this notice are preserved.
7
8 # This Makefile requires the use of GNU make.  Some targets require
9 # that you have tools like git, makeinfo and cppi installed.
10
11 # Produce some files that are not stored in the repository.
12 all:
13
14 # Produce the documentation in readable form.
15 info html dvi pdf:
16         cd doc && $(MAKE) $@ && $(MAKE) mostlyclean
17
18 # Collect the names of rules starting with `sc_'.
19 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p'\
20                         Makefile))
21
22 # Perform some platform independent checks on the gnulib code.
23 check: $(syntax-check-rules)
24
25 sc_prefer_ac_check_funcs_once:
26         if test -d .git; then                                           \
27           git grep -w -l AC_CHECK_FUNCS modules                         \
28             && { echo use AC_CHECK_FUNCS_ONCE, not AC_CHECK_FUNCS       \
29                    in modules/ 1>&2; exit 1; } || :                     \
30         else :; fi
31
32 sc_prohibit_augmenting_PATH_via_TESTS_ENVIRONMENT:
33         if test -d .git; then                                           \
34           url=http://thread.gmane.org/gmane.comp.lib.gnulib.bugs/22874; \
35           git grep '^[   ]*TESTS_ENVIRONMENT += PATH=' modules          \
36             && { printf '%s\n' 'Do not augment PATH via TESTS_ENVIRONMENT;' \
37                  "  see <$$url>" 1>&2; exit 1; } || :                   \
38         else :; fi
39
40 # Files in m4/ that (exceptionally) may use AC_LIBOBJ.
41 # Do not include their ".m4" suffix.
42 allow_AC_LIBOBJ =       \
43   close                 \
44   dprintf               \
45   dup2                  \
46   faccessat             \
47   fchdir                \
48   fclose                \
49   fcntl                 \
50   fprintf-posix         \
51   open                  \
52   printf-posix-rpl      \
53   snprintf              \
54   sprintf-posix         \
55   stdio_h               \
56   vasnprintf            \
57   vasprintf             \
58   vdprintf              \
59   vfprintf-posix        \
60   vprintf-posix         \
61   vsnprintf             \
62   vsprintf-posix
63
64 allow_AC_LIBOBJ_or := $(shell echo $(allow_AC_LIBOBJ) | tr -s ' ' '|')
65
66 sc_prohibit_AC_LIBOBJ_in_m4:
67         url=http://article.gmane.org/gmane.comp.lib.gnulib.bugs/26995;  \
68         if test -d .git; then                                           \
69           git ls-files m4                                               \
70              | grep -Ev '^m4/($(allow_AC_LIBOBJ_or))\.m4$$'             \
71              | xargs grep '^ *AC_LIBOBJ('                               \
72             && { printf '%s\n' 'Do not use AC_LIBOBJ in m4/*.m4;'       \
73                  "see <$$url>"; exit 1; } || :;                         \
74         else :; fi
75
76 sc_pragma_columns:
77         if test -d .git; then                                           \
78           git ls-files|grep '\.in\.h$$'                                 \
79               | xargs grep -l '^@PRAGMA_SYSTEM_HEADER@'                 \
80               | xargs grep -L '^@PRAGMA_COLUMNS@'                       \
81               | grep .                                                  \
82             && { printf '%s\n'                                          \
83                    'the files listed above use @PRAGMA_SYSTEM_HEADER@'  \
84                    'without also using @PRAGMA_COLUMNS@' 1>&2;          \
85                  exit 1; } || :;                                        \
86         else :; fi
87
88 # Verify that certain (for now, only Jim Meyering and Eric Blake's)
89 # *.c files are consistently cpp indented.
90 sc_cpp_indent_check:
91         ./gnulib-tool --extract-filelist \
92             $$(cd ./modules; grep -ilrE '(meyering|blake)' .) \
93           | sort -u \
94           | grep '\.c$$' \
95           | grep -v '/getloadavg\.c$$' \
96           | xargs cppi -c
97
98 # Regenerate some files that are stored in the repository.
99 regen: MODULES.html
100
101 # MODULES.html is periodically being generated and copied to the web pages at
102 # :ext:USER@cvs.savannah.gnu.org:/web/gnulib/gnulib/
103 # where it then appears at <http://www.gnu.org/software/gnulib/MODULES.html>.
104 MODULES.html: MODULES.html.sh
105         ./MODULES.html.sh > MODULES.html
106
107 # Run this rule once per year (usually early in January)
108 # to update all FSF copyright year lists here.
109 # We exclude the files listed in srclist.txt (maintained elsewhere)
110 # as well as those in tests/unictype (generated).
111 # Also exclude any file that includes the "GENERATED AUTOMATICALLY" comment,
112 # being careful not to exclude code that merely generates the comment.
113 # Also exclude doc/INSTALL*, since they too are generated.
114 update-copyright:
115         exempt=$$(mktemp);                                              \
116         grep -v '^#' config/srclist.txt|grep -v '^$$'                   \
117           | while read src dst; do                                      \
118               test -f "$$dst" && { echo "$$dst"; continue; };           \
119               test -d "$$dst" || continue;                              \
120               echo "$$dst"/$$(basename "$$src");                        \
121             done > $$exempt;                                            \
122         git ls-files tests/unictype >> $$exempt;                        \
123         git ls-files doc/INSTALL* >> $$exempt;                          \
124         git ls-files | grep -vFf $$exempt                               \
125           | xargs grep -L '^/\*.*GENERATED AUTOMATICALLY'               \
126           | UPDATE_COPYRIGHT_MAX_LINE_LENGTH=79                         \
127             UPDATE_COPYRIGHT_USE_INTERVALS=1                            \
128               xargs build-aux/update-copyright