The GNU maintainer document was recently updated to recommend that web manuals include the project bug reporting address, and gendocs.sh was modified accordingly to provide a new --email option. This patch implements that, as well as a few other things I noticed while touching maintainer files: We might as well distribute gendocs.sh, rather than forcing a user to have a gnulib checkout (even though 'make web-manual' is only a maintainer target and only accessible via GNU make). No one reported using the xdelta files, so I've gone ahead and nuked support for generating them; the next autoconf release will not include an xdelta. The Free Software Directory is no longer maintained in CVS, so the update process has changed.
However, I have not pushed a new build of the manual to the web, in part because running gendocs reported an error that I will have to report to Karl: | Generating html by node... (env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= makeinfo --html -o autoconf.html "/home/eblake/autoconf/doc/autoconf.texi") | /home/eblake/autoconf/doc/autoconf.html/m4_005ffatal.html: Too many open files From: Eric Blake <[email protected]> Date: Tue, 6 Jan 2009 08:41:34 -0700 Subject: [PATCH] Maintainer cleanups. * cfg.mk (web-manual): Use new feature of gendocs. (fetch): Fetch gendocs. * Makefile.am (EXTRA_DIST): Distribute new file. * doc/Makefile.am (EXTRA_DIST): Likewise. * .gitattributes: Ignore whitespace in upstream files. * HACKING (Other web updates): Update Free Software Directory instructions. (Upload): No longer mention xdelta. * maint.mk (xd-delta): Likewise. * build-aux/gendocs.sh: New upstream file. * doc/gendocs_template: Likewise. * build-aux/announce-gen: Resync from upstream. * build-aux/config.guess: Likewise. * build-aux/config.sub: Likewise. * build-aux/gnupload: Likewise. * build-aux/texinfo.tex: Likewise. Signed-off-by: Eric Blake <[email protected]> --- .gitattributes | 2 + ChangeLog | 24 +++- HACKING | 12 +- Makefile.am | 5 +- build-aux/announce-gen | 8 +- build-aux/config.guess | 27 +++- build-aux/config.sub | 10 +- build-aux/gendocs.sh | 361 ++++++++++++++++++++++++++++++++++++++++ build-aux/gnupload | 84 +++++++--- build-aux/texinfo.tex | 426 +++++++++++++++++++++++++++++++++--------------- cfg.mk | 9 +- doc/Makefile.am | 4 +- doc/gendocs_template | 98 +++++++++++ maint.mk | 10 +- 14 files changed, 891 insertions(+), 189 deletions(-) create mode 100755 build-aux/gendocs.sh create mode 100644 doc/gendocs_template diff --git a/.gitattributes b/.gitattributes index 82752b0..c4e3035 100644 --- a/.gitattributes +++ b/.gitattributes @@ -12,3 +12,5 @@ fdl.texi -whitespace fdl-1.3.texi -whitespace make-stds.texi -whitespace standards.texi -whitespace +gendocs.sh -whitespace +gendocs_template -whitespace diff --git a/ChangeLog b/ChangeLog index d1a5382..63dab6e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,23 @@ +2009-01-06 Eric Blake <[email protected]> + + Maintainer cleanups. + * cfg.mk (web-manual): Use new feature of gendocs. + (fetch): Fetch gendocs. + * Makefile.am (EXTRA_DIST): Distribute new file. + * doc/Makefile.am (EXTRA_DIST): Likewise. + * .gitattributes: Ignore whitespace in upstream files. + * HACKING (Other web updates): Update Free Software Directory + instructions. + (Upload): No longer mention xdelta. + * maint.mk (xd-delta): Likewise. + * build-aux/gendocs.sh: New upstream file. + * doc/gendocs_template: Likewise. + * build-aux/announce-gen: Resync from upstream. + * build-aux/config.guess: Likewise. + * build-aux/config.sub: Likewise. + * build-aux/gnupload: Likewise. + * build-aux/texinfo.tex: Likewise. + 2008-12-30 Eric Blake <[email protected]> Make it easier to track diversion bugs. @@ -18628,8 +18648,8 @@ coding: utf-8 End: - Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free - Software Foundation, Inc. + Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 + Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, are permitted provided the copyright notice and this diff --git a/HACKING b/HACKING index c7adfa4..89d17bb 100644 --- a/HACKING +++ b/HACKING @@ -136,7 +136,7 @@ If it fails, run `git tag -d v<version>', fix the problems, and go back to the step of setting the version. ** Upload -Put the tarballs/xdeltas where they should be, using the instructions +Put the tarballs where they should be, using the instructions regarding gnupload that were printed during the previous step. Verify that the files are correctly uploaded before sending a release announcement. @@ -162,14 +162,14 @@ generated output do not get expanded improperly. Post a news blurb on https://savannah.gnu.org/projects/autoconf. -Update the Free Software Directory: Checkout the CVS source, then -after making edits, mail the diff to <[email protected]>. - $ cvs -d:pserver:[email protected]:/sources/directory \ - co directory/autoconf.txt +Update the Free Software Directory: browse to: + http://directory.fsf.org/project/autoconf/ +and send an email to <[email protected]> mentioning any content +that needs to be updated. ----- -Copyright (C) 2002, 2008 Free Software Foundation, Inc. +Copyright (C) 2002, 2008, 2009 Free Software Foundation, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/Makefile.am b/Makefile.am index 4da4b29..919a298 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,7 +1,7 @@ # Make Autoconf. -# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008 Free -# Software Foundation, Inc. +# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008, +# 2009 Free Software Foundation, Inc. # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -26,6 +26,7 @@ ACLOCAL_AMFLAGS = -I m4 EXTRA_DIST = ChangeLog.0 ChangeLog.1 ChangeLog.2 \ BUGS COPYINGv3 \ GNUmakefile maint.mk cfg.mk \ + build-aux/gendocs.sh \ build-aux/git-version-gen \ build-aux/announce-gen build-aux/gnupload \ .prev-version .version diff --git a/build-aux/announce-gen b/build-aux/announce-gen index 78ca625..d1a4b25 100755 --- a/build-aux/announce-gen +++ b/build-aux/announce-gen diff --git a/build-aux/config.guess b/build-aux/config.guess index f0f0d36..3f51f4e 100755 --- a/build-aux/config.guess +++ b/build-aux/config.guess diff --git a/build-aux/config.sub b/build-aux/config.sub index 053e738..9489dc7 100755 --- a/build-aux/config.sub +++ b/build-aux/config.sub diff --git a/build-aux/gendocs.sh b/build-aux/gendocs.sh new file mode 100755 index 0000000..ba76744 --- /dev/null +++ b/build-aux/gendocs.sh diff --git a/build-aux/gnupload b/build-aux/gnupload index b90e3ae..12c9394 100755 --- a/build-aux/gnupload +++ b/build-aux/gnupload diff --git a/build-aux/texinfo.tex b/build-aux/texinfo.tex index fb83ce5..fb2496b 100644 --- a/build-aux/texinfo.tex +++ b/build-aux/texinfo.tex diff --git a/cfg.mk b/cfg.mk index 2d6ce99..a27bfcf 100644 --- a/cfg.mk +++ b/cfg.mk @@ -1,5 +1,6 @@ # Customize maint.mk for Autoconf. -*- Makefile -*- -# Copyright (C) 2003, 2004, 2006, 2008 Free Software Foundation, Inc. +# Copyright (C) 2003, 2004, 2006, 2008, 2009 Free Software Foundation, +# Inc. # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -49,6 +50,7 @@ fetch: cp $(gnulib_dir)/build-aux/config.guess $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/config.sub $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/elisp-comp $(srcdir)/build-aux + cp $(gnulib_dir)/build-aux/gendocs.sh $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/git-version-gen $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/gnupload $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/install-sh $(srcdir)/build-aux @@ -57,6 +59,7 @@ fetch: cp $(gnulib_dir)/build-aux/vc-list-files $(srcdir)/build-aux cp $(gnulib_dir)/build-aux/texinfo.tex $(srcdir)/build-aux cp $(gnulib_dir)/doc/fdl.texi $(srcdir)/doc + cp $(gnulib_dir)/doc/gendocs_template $(srcdir)/doc cp $(gnulib_dir)/doc/gnu-oids.texi $(srcdir)/doc cp $(gnulib_dir)/doc/make-stds.texi $(srcdir)/doc cp $(gnulib_dir)/doc/standards.texi $(srcdir)/doc @@ -69,7 +72,7 @@ local-checks-to-skip ?= \ .PHONY: web-manual web-manual: @cd $(srcdir)/doc ; \ - GENDOCS_TEMPLATE_DIR=$(gnulib_dir)/doc; export GENDOCS_TEMPLATE_DIR; \ - $(SHELL) $(gnulib_dir)/build-aux/gendocs.sh autoconf \ + $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \ + --email $(PACKAGE_BUGREPORT) $(PACKAGE) \ "$(PACKAGE_NAME) - Creating Automatic Configuration Scripts" @echo " *** Upload the doc/manual directory to web-cvs." diff --git a/doc/Makefile.am b/doc/Makefile.am index 38abc5f..1e4e53e 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,6 +1,6 @@ # Make Autoconf documentation. -# Copyright (C) 2000, 2001, 2002, 2003, 2007, 2008 Free Software +# Copyright (C) 2000, 2001, 2002, 2003, 2007, 2008, 2009 Free Software # Foundation, Inc. # This program is free software: you can redistribute it and/or modify @@ -24,6 +24,8 @@ info_TEXINFOS = autoconf.texi standards.texi autoconf_TEXINFOS = fdl.texi install.texi standards_TEXINFOS = fdl.texi gnu-oids.texi make-stds.texi +EXTRA_DIST = gendocs_template + # Files from texi2dvi that should be removed, but which Automake does # not know. CLEANFILES = autoconf.ACs autoconf.cvs autoconf.MSs autoconf.prs \ diff --git a/doc/gendocs_template b/doc/gendocs_template new file mode 100644 index 0000000..94cecef --- /dev/null +++ b/doc/gendocs_template diff --git a/maint.mk b/maint.mk index 227720e..5f5a48c 100644 --- a/maint.mk +++ b/maint.mk @@ -2,7 +2,7 @@ # This Makefile fragment tries to be general-purpose enough to be # used by at least coreutils, idutils, CPPI, Bison, and Autoconf. -## Copyright (C) 2001-2008 Free Software Foundation, Inc. +## Copyright (C) 2001-2009 Free Software Foundation, Inc. ## ## This program is free software: you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -52,7 +52,7 @@ this-vc-tag-regexp = v$(VERSION_REGEXP) my_distdir = $(PACKAGE)-$(VERSION) # Old releases are stored here. -# Used for diffs and xdeltas. +# Used for diffs. release_archive_dir ?= ../release # Prevent programs like 'sort' from considering distinct strings to be equal. @@ -525,9 +525,8 @@ my-distcheck: $(local-check) $(release_archive_dir)/$(prev- tgz) echo "========================" prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz -xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta -rel-files = $(xd-delta) $(DIST_ARCHIVES) +rel-files = $(DIST_ARCHIVES) announcement: NEWS ChangeLog $(rel-files) @$(announce_gen) \ --release-type=$(RELEASE_TYPE) \ @@ -559,9 +558,6 @@ emit_upload_commands: @echo ===================================== @echo ===================================== -$(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz - xdelta delta -9 $^ $@ || : - .PHONY: alpha beta major alpha beta major: news-date-check changelog-check $(local-check) test $@ = major \ -- 1.6.0.4
