]> Savannah Git Hosting - gnulib.git/commitdiff
maintainer-makefile: Enforce the GNU Coding Standards in the README.
authorJose E. Marchesi <jemarch@gnu.org>
Tue, 6 Jun 2023 17:35:35 +0000 (19:35 +0200)
committerBruno Haible <bruno@clisp.org>
Tue, 6 Jun 2023 17:38:40 +0000 (19:38 +0200)
* top/maint.mk (sc_readme_link_install): New rule.
(sc_readme_link_copying): Likewise.

ChangeLog
top/maint.mk

index a917eb63a6f898da8dbac2de937a2ed7674ac37a..cb885ba9a2256359e8f8891dd662a7e726d8170a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2023-06-06  Jose E. Marchesi  <jemarch@gnu.org>
+
+       maintainer-makefile: Enforce the GNU Coding Standards in the README.
+       * top/maint.mk (sc_readme_link_install): New rule.
+       (sc_readme_link_copying): Likewise.
+
 2023-06-05  Paul Eggert  <eggert@cs.ucla.edu>
 
        copy-file-range: support building for older kernels
index 44f3db9d9d786535e3b04fa81f810a6095929828..4f5729fac135fbc865a482b14d4d9c7f15f1aa6c 100644 (file)
@@ -1377,6 +1377,22 @@ sc_unportable_grep_q:
        @prohibit='grep -q' halt="unportable 'grep -q', use >/dev/null instead" \
          $(_sc_search_regexp)
 
+# The GNU Codying standards says that README should refer to both
+# INSTALL and the file that contains the copying conditions.  This
+# shall be COPYING for GPL and COPYING.LESSER for LGPL.
+
+sc_readme_link_install:
+       @require='INSTALL'                                      \
+       in_vc_files='$(top_srcdir)/README$$'                    \
+       halt='The README file should refer to INSTALL'          \
+         $(_sc_search_regexp)
+
+sc_readme_link_copying:
+       @require='COPYING'                                      \
+       in_vc_files='$(top_srcdir)/README$$'                    \
+       halt='The README file should refer to COPYING[.LESSER]' \
+         $(_sc_search_regexp)
+
 vc-diff-check:
        $(AM_V_GEN)(unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
        $(AM_V_at)if test -s vc-diffs; then                     \