Todo: ntfsclone.
[libguestfs.git] / cfg.mk
1 # Customize Makefile.maint.                           -*- makefile -*-
2 # Copyright (C) 2003-2009 Free Software Foundation, Inc.
3
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
8
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13
14 # You should have received a copy of the GNU General Public License
15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 # Use alpha.gnu.org for alpha and beta releases.
18 # Use ftp.gnu.org for major releases.
19 gnu_ftp_host-alpha = alpha.gnu.org
20 gnu_ftp_host-beta = alpha.gnu.org
21 gnu_ftp_host-major = ftp.gnu.org
22 gnu_rel_host = $(gnu_ftp_host-$(RELEASE_TYPE))
23
24 url_dir_list = \
25   ftp://$(gnu_rel_host)/gnu/coreutils
26
27 # Tests not to run as part of "make distcheck".
28 local-checks-to-skip =                  \
29   sc_po_check                           \
30   changelog-check                       \
31   check-AUTHORS                         \
32   makefile-check                        \
33   makefile_path_separator_check         \
34   patch-check                           \
35   sc_GPL_version                        \
36   sc_always_defined_macros              \
37   sc_cast_of_alloca_return_value        \
38   sc_dd_max_sym_length                  \
39   sc_error_exit_success                 \
40   sc_file_system                        \
41   sc_immutable_NEWS                     \
42   sc_makefile_path_separator_check      \
43   sc_obsolete_symbols                   \
44   sc_prohibit_S_IS_definition           \
45   sc_prohibit_atoi_atof                 \
46   sc_prohibit_jm_in_m4                  \
47   sc_prohibit_quote_without_use         \
48   sc_prohibit_quotearg_without_use      \
49   sc_prohibit_stat_st_blocks            \
50   sc_prohibit_strcmp_and_strncmp        \
51   sc_prohibit_strcmp                    \
52   sc_root_tests                         \
53   sc_space_tab                          \
54   sc_sun_os_names                       \
55   sc_system_h_headers                   \
56   sc_tight_scope                        \
57   sc_two_space_separator_in_usage       \
58   sc_error_message_uppercase            \
59   sc_program_name                       \
60   sc_require_test_exit_idiom            \
61   sc_makefile_check                     \
62   $(disable_temporarily)                \
63   sc_useless_cpp_parens
64
65 disable_temporarily =                   \
66   sc_unmarked_diagnostics               \
67   sc_prohibit_ctype_h                   \
68   sc_prohibit_asprintf                  \
69   sc_m4_quote_check                     \
70   sc_avoid_ctype_macros                 \
71   sc_avoid_write
72
73 # Avoid uses of write(2).  Either switch to streams (fwrite), or use
74 # the safewrite wrapper.
75 sc_avoid_write:
76         @if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then          \
77           grep '\<write *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$') &&     \
78             { echo "$(ME): the above files use write;"                  \
79               " consider using the safewrite wrapper instead"           \
80                   1>&2; exit 1; } || :;                                 \
81         else :;                                                         \
82         fi
83
84 # Use STREQ rather than comparing strcmp == 0, or != 0.
85 # Similarly, use STREQLEN or STRPREFIX rather than strncmp.
86 sc_prohibit_strcmp_and_strncmp:
87         @grep -nE '! *strn?cmp *\(|\<strn?cmp *\([^)]+\) *=='           \
88             $$($(VC_LIST_EXCEPT))                                       \
89           | grep -vE ':# *define STREQ(LEN)?\(' &&                      \
90           { echo '$(ME): use STREQ(LEN) in place of the above uses of strcmp(strncmp)' \
91                 1>&2; exit 1; } || :
92
93 # Use virAsprintf rather than a'sprintf since *strp is undefined on error.
94 sc_prohibit_asprintf:
95         @re='\<[a]sprintf\>'                                            \
96         msg='use virAsprintf, not a'sprintf                             \
97           $(_prohibit_regexp)
98
99 # Prohibit the inclusion of <ctype.h>.
100 sc_prohibit_ctype_h:
101         @grep -E '^# *include  *<ctype\.h>' $$($(VC_LIST_EXCEPT)) &&    \
102           { echo "$(ME): don't use ctype.h; instead, use c-ctype.h"     \
103                 1>&2; exit 1; } || :
104
105 # Ensure that no C source file uses TABs for indentation.
106 # Exclude some version-controlled symlinks.
107 sc_TAB_in_indentation:
108         @grep -lE '^ *  ' /dev/null                                     \
109              $$($(VC_LIST_EXCEPT)) &&                                   \
110           { echo '$(ME): found TAB(s) used for indentation in C sources;'\
111               'use spaces' 1>&2; exit 1; } || :
112
113 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
114 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
115
116 sc_avoid_ctype_macros:
117         @grep -E '\b($(ctype_re)) *\(' /dev/null                        \
118              $$($(VC_LIST_EXCEPT)) &&                                   \
119           { echo "$(ME): don't use ctype macros (use c-ctype.h)"        \
120                 1>&2; exit 1; } || :
121
122 sc_prohibit_virBufferAdd_with_string_literal:
123         @re='\<virBufferAdd *\([^,]+, *"[^"]'                           \
124         msg='use virBufferAddLit, not virBufferAdd, with a string literal' \
125           $(_prohibit_regexp)
126
127 # Not only do they fail to deal well with ipv6, but the gethostby*
128 # functions are also not thread-safe.
129 sc_prohibit_gethostby:
130         @re='\<gethostby(addr|name2?) *\('                              \
131         msg='use getaddrinfo, not gethostby*'                           \
132           $(_prohibit_regexp)
133
134 # Disallow trailing blank lines.
135 sc_prohibit_trailing_blank_lines:
136         @$(VC_LIST_EXCEPT)                                              \
137           | xargs perl -ln -0777 -e                                     \
138               '-f $$ARGV or next; /\n\n+$$/ and print $$ARGV' > $@-t
139         @found=0; test -s $@-t && { found=1; cat $@-t 1>&2;             \
140           echo '$(ME): found trailing blank line(s)' 1>&2; };           \
141         rm -f $@-t;                                                     \
142         test $$found = 0
143
144 # We don't use this feature of maint.mk.
145 prev_version_file = /dev/null
146
147 ifeq (0,$(MAKELEVEL))
148   _curr_status = .git-module-status
149   # The sed filter accommodates those who check out on a commit from which
150   # no tag is reachable.  In that case, git submodule status prints a "-"
151   # in column 1 and does not print a "git describe"-style string after the
152   # submodule name.  Contrast these:
153   # -b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib
154   #  b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib (v0.0-2286-gb653eda)
155   _submodule_hash = sed 's/.//;s/ .*//'
156   _update_required := $(shell                                           \
157       actual=$$(git submodule status | $(_submodule_hash));             \
158       stamp="$$($(_submodule_hash) $(_curr_status) 2>/dev/null)";       \
159       test "$$stamp" = "$$actual"; echo $$?)
160   ifeq (1,$(_update_required))
161     $(error gnulib update required; run ./autogen.sh first)
162   endif
163 endif