]> Savannah Git Hosting - gnulib.git/commitdiff
maint.mk: Add more comments.
authorBruno Haible <bruno@clisp.org>
Sun, 18 Feb 2024 20:34:01 +0000 (21:34 +0100)
committerBruno Haible <bruno@clisp.org>
Sun, 18 Feb 2024 20:34:01 +0000 (21:34 +0100)
* top/maint.mk: Reference the Gnulib documentation where suitable.

ChangeLog
top/maint.mk

index a3f316e3cc7d4d347457806cbb9ae2b8f4b7b06b..3a8559bfb372e0ca8eaedc6e40c0fc727fd0f6b4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2024-02-18  Bruno Haible  <bruno@clisp.org>
+
+       maint.mk: Add more comments.
+       * top/maint.mk: Reference the Gnulib documentation where suitable.
+
 2024-02-18  Collin Funk  <collin.funk1@gmail.com>
 
        maint.mk: Add syntax-check rule to check for #include syntax.
index 9725976daec855465a93c267d9c96adb262c8e27..5746b911dd4655a00542f0aa6b157dc380617729 100644 (file)
@@ -503,6 +503,7 @@ sc_prohibit_have_config_h:
 # Nearly all .c files must include <config.h>.  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>'.
 config_h_header ?= <config\.h>
 sc_require_config_h:
        @require='^# *include $(config_h_header)'                       \
@@ -526,6 +527,7 @@ perl_config_h_first_ =                                                      \
 
 # You must include <config.h> 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 <config.h>'.
 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 <header.h>' 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\)$$');  \