Mercurial > gnulib

comparison doc/standards.texi @ 17352:5cadd9d309b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
autoupdate
author Karl Berry <karl@freefriends.org>
date Sat, 09 Mar 2013 07:23:53 -0800
parents 603aa5fbb298
children 8826dc2ee3ee
comparison
equal deleted inserted replaced
17351:35650a3443e8 17352:5cadd9d309b1
1 \input texinfo @c -*-texinfo-*- 1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header 2 @c %**start of header
3 @setfilename standards.info 3 @setfilename standards.info
4 @settitle GNU Coding Standards 4 @settitle GNU Coding Standards
5 @c This date is automagically updated when you save this file: 5 @c This date is automagically updated when you save this file:
6 @set lastupdate February 13, 2013 6 @set lastupdate March 8, 2013
7 @c %**end of header 7 @c %**end of header
8 8
9 @dircategory GNU organization 9 @dircategory GNU organization
10 @direntry 10 @direntry
11 * Standards: (standards). GNU coding standards. 11 * Standards: (standards). GNU coding standards.
3371 If necessary, add extra chapters at the beginning of the manual which 3371 If necessary, add extra chapters at the beginning of the manual which
3372 are purely tutorial and cover the basics of the subject. These provide 3372 are purely tutorial and cover the basics of the subject. These provide
3373 the framework for a beginner to understand the rest of the manual. The 3373 the framework for a beginner to understand the rest of the manual. The
3374 Bison manual provides a good example of how to do this. 3374 Bison manual provides a good example of how to do this.
3375 3375
3376 To serve as a reference, a manual should have an Index that list all the 3376 To serve as a reference, a manual should have an Index that lists all
3377 functions, variables, options, and important concepts that are part of 3377 the functions, variables, options, and important concepts that are
3378 the program. One combined Index should do for a short manual, but 3378 part of the program. One combined Index should do for a short manual,
3379 sometimes for a complex package it is better to use multiple indices. 3379 but sometimes for a complex package it is better to use multiple
3380 The Texinfo manual includes advice on preparing good index entries, see 3380 indices. The Texinfo manual includes advice on preparing good index
3381 @ref{Index Entries, , Making Index Entries, texinfo, GNU Texinfo}, and 3381 entries, see @ref{Index Entries, , Making Index Entries, texinfo, GNU
3382 see @ref{Indexing Commands, , Defining the Entries of an 3382 Texinfo}, and see @ref{Indexing Commands, , Defining the Entries of an
3383 Index, texinfo, GNU Texinfo}. 3383 Index, texinfo, GNU Texinfo}.
3384 3384
3385 Don't use Unix man pages as a model for how to write GNU documentation; 3385 Don't use Unix man pages as a model for how to write GNU documentation;
3386 most of them are terse, badly structured, and give inadequate 3386 most of them are terse, badly structured, and give inadequate
3387 explanation of the underlying concepts. (There are, of course, some 3387 explanation of the underlying concepts. (There are, of course, some