From: Jose E. Marchesi Date: Tue, 6 Jun 2023 17:35:35 +0000 (+0200) Subject: maintainer-makefile: Enforce the GNU Coding Standards in the README. X-Git-Tag: v1.0~1245 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=53b4bf3018;p=gnulib.git maintainer-makefile: Enforce the GNU Coding Standards in the README. * top/maint.mk (sc_readme_link_install): New rule. (sc_readme_link_copying): Likewise. --- diff --git a/ChangeLog b/ChangeLog index a917eb63a6..cb885ba9a2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2023-06-06 Jose E. Marchesi + + 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 copy-file-range: support building for older kernels diff --git a/top/maint.mk b/top/maint.mk index 44f3db9d9d..4f5729fac1 100644 --- a/top/maint.mk +++ b/top/maint.mk @@ -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 \