diff options
author | Karl Berry <karl@freefriends.org> | 2012-10-29 11:19:41 -0700 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-10-29 11:19:41 -0700 |
commit | 3ac269ac422ab53755f80262bdda7547f3f50cd6 (patch) | |
tree | 12cd4d85d435073df2be3b81405945449e01cd34 /doc | |
parent | 4027785526fce3ec49b4c2b2dcd40df07f8a211d (diff) | |
download | gnulib-3ac269ac422ab53755f80262bdda7547f3f50cd6.tar.gz |
autoupdate
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gendocs_template | 2 | ||||
-rw-r--r-- | doc/gendocs_template_min | 3 | ||||
-rw-r--r-- | doc/maintain.texi | 20 | ||||
-rw-r--r-- | doc/standards.texi | 42 |
4 files changed, 39 insertions, 28 deletions
diff --git a/doc/gendocs_template b/doc/gendocs_template index f3a3ff64c5..a62ad6167b 100644 --- a/doc/gendocs_template +++ b/doc/gendocs_template @@ -45,8 +45,6 @@ (%%ASCII_GZ_SIZE%%K bytes gzipped)</a>.</li> <li><a href="%%PACKAGE%%.dvi.gz">TeX dvi file (%%DVI_GZ_SIZE%%K bytes gzipped)</a>.</li> -<li><a href="%%PACKAGE%%.ps.gz">PostScript file - (%%PS_GZ_SIZE%%K bytes gzipped)</a>.</li> <li><a href="%%PACKAGE%%.pdf">PDF file (%%PDF_SIZE%%K bytes)</a>.</li> <li><a href="%%PACKAGE%%.texi.tar.gz">Texinfo source diff --git a/doc/gendocs_template_min b/doc/gendocs_template_min index 4890b679a0..93b9c19efa 100644 --- a/doc/gendocs_template_min +++ b/doc/gendocs_template_min @@ -7,7 +7,6 @@ <title>%%TITLE%% - GNU Project - Free Software Foundation (FSF)</title> <meta http-equiv="content-type" content='text/html; charset=utf-8' /> <link rel="stylesheet" type="text/css" href="/gnu.css" /> -<link rev="made" href="webmasters@gnu.org" /> </head> <body> @@ -63,8 +62,6 @@ (%%ASCII_GZ_SIZE%%K bytes gzipped)</a>.</li> <li><a href="%%PACKAGE%%.dvi.gz">TeX dvi file (%%DVI_GZ_SIZE%%K bytes gzipped)</a>.</li> -<li><a href="%%PACKAGE%%.ps.gz">PostScript file - (%%PS_GZ_SIZE%%K bytes gzipped)</a>.</li> <li><a href="%%PACKAGE%%.pdf">PDF file (%%PDF_SIZE%%K bytes)</a>.</li> <li><a href="%%PACKAGE%%.texi.tar.gz">Texinfo source diff --git a/doc/maintain.texi b/doc/maintain.texi index 9549192f94..2bc48f448c 100644 --- a/doc/maintain.texi +++ b/doc/maintain.texi @@ -5,7 +5,7 @@ @c For double-sided printing, uncomment: @c @setchapternewpage odd @c This date is automagically updated when you save this file: -@set lastupdate August 24, 2012 +@set lastupdate October 27, 2012 @c %**end of header @dircategory GNU organization @@ -1911,6 +1911,7 @@ on @code{www.gnu.org} link to that site. @node Hosting for Web Pages @section Hosting for Web Pages +@cindex web pages, hosting for The best way to maintain the web pages for your project is to register the project on @code{savannah.gnu.org}. Then you can edit the pages @@ -1935,6 +1936,7 @@ For details, see @node Freedom for Web Pages @section Freedom for Web Pages +@cindex web pages, freedom for If you use a site other than @code{www.gnu.org}, please make sure that the site runs on free software alone. (It is ok if the site uses @@ -1958,11 +1960,14 @@ generally superior. See @url{http://www.gnu.org/philosophy/gif.html}. @node Manuals on Web Pages @section Manuals on Web Pages +@cindex web pages, including manuals on +@cindex formats for documentation, desired The web pages for the package should include its manuals, in HTML, -DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source). -All of these can be generated automatically from the Texinfo source -using Makeinfo and other programs. +DVI, Info, PDF, plain ASCII, and the source Texinfo. All of these can +be generated automatically from Texinfo using Makeinfo and other +programs. If the Texinfo itself is generated from some other source +format, include that too. When there is only one manual, put it in a subdirectory called @file{manual}; the file @file{manual/index.html} should have a link to @@ -1990,6 +1995,7 @@ will do so based on the contents of your @file{manual} directory. @subsection Invoking @command{gendocs.sh} @pindex gendocs.sh @cindex generating documentation output +@cindex documentation output, generating The script @command{gendocs.sh} eases the task of generating the Texinfo documentation output for your web pages @@ -2069,15 +2075,15 @@ HTML output generated by @command{texi2html} (i.e., split by sections and chapters). You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI}, -@env{TEXI2HTML} and @env{DVIPS} to control the programs that get -executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the +etc., to control the programs that get executed, and +@env{GENDOCS_TEMPLATE_DIR} to control where the @file{gendocs_template} file is found. As usual, run @samp{gendocs.sh --help} for a description of all the options, environment variables, and more information. Please email bug reports, enhancement requests, or other -correspondence to @email{bug-texinfo@@gnu.org}. +correspondence about @command{gendocs} to @email{bug-texinfo@@gnu.org}. @node CVS Keywords in Web Pages diff --git a/doc/standards.texi b/doc/standards.texi index fc92652786..7fde2e82df 100644 --- a/doc/standards.texi +++ b/doc/standards.texi @@ -3,7 +3,7 @@ @setfilename standards.info @settitle GNU Coding Standards @c This date is automagically updated when you save this file: -@set lastupdate June 30, 2012 +@set lastupdate October 27, 2012 @c %**end of header @dircategory GNU organization @@ -4063,6 +4063,7 @@ ignore most of its arguments. @section Making Releases @cindex packaging +@cindex version numbers, for releases You should identify each release with a pair of version numbers, a major version and a minor. We have no objection to using more than two numbers, but it is very unlikely that you really need them. @@ -4079,20 +4080,28 @@ and never changed automatically; non-source files are produced from source files by programs under the control of the Makefile. @cindex @file{README} file -The distribution should contain a file named @file{README} which gives -the name of the package, and a general description of what it does. It -is also good to explain the purpose of each of the first-level -subdirectories in the package, if there are any. The @file{README} file -should either state the version number of the package, or refer to where -in the package it can be found. - -The @file{README} file should refer to the file @file{INSTALL}, which -should contain an explanation of the installation procedure. - -The @file{README} file should also refer to the file which contains the -copying conditions. The GNU GPL, if used, should be in a file called -@file{COPYING}. If the GNU LGPL is used, it should be in a file called +The distribution should contain a file named @file{README} with a +general overview of the package: + +@itemize +@item the name of the package; + +@item the version number of the package, or refer to where in the +package the version can be found; + +@item a general description of what the package does; + +@item a reference to the the file @file{INSTALL}, which +should in turn contain an explanation of the installation procedure; + +@item a brief explanation of any unusual top-level directories or +files, or other hints for readers to find their way around the source; + +@item a reference to the file which contains the copying conditions. +The GNU GPL, if used, should be in a file called @file{COPYING}. If +the GNU LGPL is used, it should be in a file called @file{COPYING.LESSER}. +@end itemize Naturally, all the source files must be in the distribution. It is okay to include non-source files in the distribution along with the @@ -4100,9 +4109,10 @@ source files they are generated from, provided they are up-to-date with the source they are made from, and machine-independent, so that normal building of the distribution will never modify them. We commonly include non-source files produced by Autoconf, Automake, -Bison, @code{lex}, @TeX{}, and @code{makeinfo}; this helps avoid +Bison, @code{flex}, @TeX{}, and @code{makeinfo}; this helps avoid unnecessary dependencies between our distributions, so that users can -install whichever packages they want to install. +install whichever versions of whichever packages they like. Do not +induce new dependencies on other software lightly. Non-source files that might actually be modified by building and installing the program should @strong{never} be included in the |