From 1282ecc274d1830cbf4ed7e5f718a0452476979d Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Fri, 13 Sep 1996 00:43:18 +0000 Subject: [PATCH] Doc updates --- automake.in | 2 +- automake.texi | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++ version.texi | 2 +- 3 files changed, 56 insertions(+), 2 deletions(-) diff --git a/automake.in b/automake.in index afb9652b..41f3537e 100755 --- a/automake.in +++ b/automake.in @@ -1469,7 +1469,7 @@ sub handle_dist_worker # in case some explanatory text is desirable. $output_rules .= ' @if sed 15q $(srcdir)/NEWS | fgrep -e "$(VERSION)" > /dev/null; then :; else \\ echo "NEWS not updated; not releasing" 1>&2; \\ - exit 1; \\ + exit 1; \\ fi '; } diff --git a/automake.texi b/automake.texi index 61845a85..02af5597 100644 --- a/automake.texi +++ b/automake.texi @@ -113,6 +113,7 @@ documents version @value{VERSION}. * Tests:: Support for test suites * Options:: Changing Automake's behavior * Miscellaneous:: Miscellaneous rules +* Gnits:: What --gnu and --gnits really do * Extending:: Extending Automake * Distributing:: Distributing the Makefile.in * Examples:: Some example packages @@ -373,6 +374,9 @@ recommended that you avoid this option until such time as the GNITS standard is actually published. @end table +For more information on the precise implications of the strictness +level, see @xref{Gnits}. + @node Uniform @section The Uniform Naming Scheme @@ -1586,6 +1590,56 @@ of new suffixes in the @code{SUFFIXES} variable. FIXME write this +@node Gnits +@chapter What --gnu and --gnits really do + +The @samp{--gnu} option, as mentioned earlier, attempts to check as much +of the GNU standards as possible. Here is a more detailed list of what +@samp{--gnu} implies: + +@itemize @bullet +@item +The files @file{INSTALL}, @file{NEWS}, @file{README}, @file{COPYING}, +@file{AUTHORS}, and @file{ChangeLog} are required at the topmost +directory of the package. + +@item +The options @samp{no-installman} and @samp{no-installinfo} are +prohibited. +@end itemize + +Note that this option will be extended in the future to do even more +checking; it is advisable to be familiar with the precise requirements +of the GNU standards. Also, @samp{--gnu} can require certain +non-standard GNU programs to exist for use by various maintainer-only +targets; for instance in the future @code{pathchk} might be required. + +The @samp{--gnits} option does everything that @samp{--gnu} does, and +checks the following as well: + +@itemize @bullet +@item +@samp{make dist} will check to make sure the @file{NEWS} file has been +updated to the current version. + +@item +The file @file{COPYING.LIB} is prohibited. + +@item +@samp{VERSION} is checked to make sure its format complies with Gnits +standards. +@c FIXME xref when standards are finished + +@item +If the version number indicates that this is an alpha release, and the +file @file{README-alpha} appears in the topmost directory of a package, +then it is included in the distribution. + +@item +The file @file{THANKS} is required. +@end itemize + + @node Extending @chapter When Automake Isn't Enough diff --git a/version.texi b/version.texi index 9672ca83..7dbe3f7f 100644 --- a/version.texi +++ b/version.texi @@ -1,3 +1,3 @@ -@set UPDATED 8 September 1996 +@set UPDATED 12 September 1996 @set EDITION 1.1f @set VERSION 1.1f -- 2.43.5