From: Bruno Haible Date: Sun, 18 Feb 2024 20:34:01 +0000 (+0100) Subject: maint.mk: Add more comments. X-Git-Tag: v1.0~406 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=76ce0307b4f41fbbaa0ffec42e12b8dce7d87798;p=gnulib.git maint.mk: Add more comments. * top/maint.mk: Reference the Gnulib documentation where suitable. --- diff --git a/ChangeLog b/ChangeLog index a3f316e3cc..3a8559bfb3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2024-02-18 Bruno Haible + + maint.mk: Add more comments. + * top/maint.mk: Reference the Gnulib documentation where suitable. + 2024-02-18 Collin Funk maint.mk: Add syntax-check rule to check for #include syntax. diff --git a/top/maint.mk b/top/maint.mk index 9725976dae..5746b911dd 100644 --- a/top/maint.mk +++ b/top/maint.mk @@ -503,6 +503,7 @@ sc_prohibit_have_config_h: # Nearly all .c files must include . However, we also permit this # via inclusion of a package-specific header, if cfg.mk specified one. # config_h_header must be suitable for grep -E. +# Rationale: The Gnulib documentation, node 'Include '. config_h_header ?= sc_require_config_h: @require='^# *include $(config_h_header)' \ @@ -526,6 +527,7 @@ perl_config_h_first_ = \ # You must include before including any other header file. # This can possibly be via a package-specific header, if given by cfg.mk. +# Rationale: The Gnulib documentation, node 'Include '. sc_require_config_h_first: @if $(VC_LIST_EXCEPT) | $(GREP) '\.c$$' > /dev/null; then \ files=$$($(VC_LIST_EXCEPT) | $(GREP) '\.c$$') && \ @@ -607,7 +609,8 @@ gl_absolute_include_headers_ ?= \ wctype.h # Suggest using '#include ' instead of '#include "header.h"' for -# headers that substitute system headers. +# headers that override system headers. +# Rationale: The Gnulib documentation, node 'Style of #include statements'. sc_verify_absolute_include_headers: @if $(VC_LIST_EXCEPT) | $(GREP) '\.c$$' > /dev/null; then \ source_files=$$($(VC_LIST_EXCEPT) | $(GREP) '\.\(c\|h\)$$'); \