mirror of https://github.com/mkerrisk/man-pages
prepare for 2.10
This commit is contained in:
parent
6f9c0c6b3b
commit
30ac2aa66f
56
Changes
56
Changes
|
@ -1,28 +1,52 @@
|
|||
==================== Changes in man-pages-2.10 ====================
|
||||
|
||||
Released: ????-??-??
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
||||
The following people contributed notes, ideas, or patches that have
|
||||
been incorporated in changes in this release:
|
||||
|
||||
|
||||
Apologies if I missed anyone!
|
||||
Released: 2005-10-19
|
||||
|
||||
Global changes
|
||||
--------------
|
||||
|
||||
The changes in this release consist *solely* of formatting fixes, with
|
||||
the aim bringing greater consistency to the manual pages according to
|
||||
the following rules:
|
||||
|
||||
Typographical or grammatical errors have been corrected in several
|
||||
places.
|
||||
-- Function name references should *always* be followed by
|
||||
parentheses, "()" (possibly containing a manual page section
|
||||
number).
|
||||
|
||||
-- The parentheses following a function name should *not* be
|
||||
formatted. Thus, for example, instead of:
|
||||
|
||||
New pages
|
||||
---------
|
||||
.B name()
|
||||
|
||||
one should write:
|
||||
|
||||
Changes to individual pages
|
||||
---------------------------
|
||||
.BR name ()
|
||||
|
||||
Much of the change was automated using two scripts:
|
||||
add_parens_for_own_funcs.sh and unformat_parens.sh.
|
||||
For the (possible) benefit of downstream manual page maintainers and
|
||||
translators, I have placed these scripts in a new subdirectory 'scripts'.
|
||||
|
||||
NOTE THE FOLLOWING POINTS WELL:
|
||||
|
||||
-- These scripts provide a computer-assisted solution to the above
|
||||
two goals. However, they are not perfect, and their output should
|
||||
be scanned by a human. (To see what changes the two scripts
|
||||
*would* make, without making them, use the "-n" command line option.)
|
||||
|
||||
-- The scripts do not fix all instances that violate the above rules:
|
||||
some manual fixes are required. Two further scripts are provided
|
||||
to help find remaining instances of function names without
|
||||
following "()": find_dots_no_parens.sh and find_slashes_no_parens.sh.
|
||||
|
||||
The following changes were made:
|
||||
|
||||
-- add_parens_for_own_funcs.sh was applied to the pages in Sections
|
||||
2 and 3.
|
||||
|
||||
-- unformat_parens.sh was applied to pages in Sections 2, 3, 4, and 7
|
||||
(the only sections where such changes were required).
|
||||
|
||||
-- further changes (not so very many) were performed by hand.
|
||||
(found places to fix with the assistance of find_dots_no_parens.sh
|
||||
and find_slashes_no_parens.sh).
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
Begin3
|
||||
Title: Section 2, 3, 4, 5 and 7 man pages for Linux
|
||||
Version: 2.10
|
||||
Entered-date: ????-??-??
|
||||
Entered-date: 2005-10-19
|
||||
Description: Linux and POSIX manual pages
|
||||
Keywords: man pages
|
||||
Author: several
|
||||
|
|
Loading…
Reference in New Issue