[PATCH v2 0/5] Header & Standards Cleanup

[Rical Jasan <ricaljasan@pacific.net>]

[-- Attachment #1: Type: text/plain, Size: 3043 bytes --]

There exists a convention for annotating which headers and standards a
given function, variable, etc., provided by the glibc come from,
guaranteeing their automatic inclusion in the Summary of Library
Facilities, where they are indexed along with their headers and
standards.  The convention is based upon expectations present in
manual/summary.awk, though that script does not do any enforcing,
merely indexing what it can find.  It is roughly:

  @comment HEADER(S)
  @comment STANDARD(S)
  @(def|item|vindex)

It would be nice to use something other than ad-hoc @comments for such
annotations, and also provide a framework for ensuring annotations
exist and are correctly formatted.

Checking for missing or invalid annotations would yield a plethora of
errors in the manual's current state, so the first step is simply to
make annotations complete or correct, according to the expectations of
summary.awk.  This results in many new and fixed entries in the
Summary, while making subsequent work on a more comprehensive
framework easier.

A new script is introduced, check-stds.pl, which will indicate an
error for any missing or invalid annotations, and report them.

A convention for standards names is currently under discussion, and
this patchset assumes certain names will be preferred.  To that end,
some alternate spellings/representations of standards are changed in
order to reduce the variety of standards names in current use, making
future work on consistent names easier.

Over 300 new entries are added to the Summary of Library Facilities as
a result of this patchset, and many others have their entries fixed
(commonly due to a header having been displayed as a standard).
---
 manual/Makefile      |   1 +
 manual/argp.texi     |  28 +++++++
 manual/arith.texi    |  38 ++++++++--
 manual/check-stds.pl | 211 +++++++++++++++++++++++++++++++++++++++++++++++++++
 manual/conf.texi     |  72 +++++++++---------
 manual/creature.texi |  12 +--
 manual/filesys.texi  |  91 +++++++++++++---------
 manual/ipc.texi      |  28 +++++++
 manual/lang.texi     |  20 +++++
 manual/llio.texi     | 118 +++++++++++++++++++++++-----
 manual/locale.texi   | 168 +++++++++++++++++++++++++++++++++++++++-
 manual/math.texi     |  26 +++++++
 manual/memory.texi   |  33 +++++++-
 manual/message.texi  |   6 +-
 manual/nss.texi      |  12 ++-
 manual/pattern.texi  |  36 +++++++++
 manual/platform.texi |  20 +++++
 manual/process.texi  |  16 +++-
 manual/resource.texi |  57 +++++++++-----
 manual/search.texi   |  16 +++-
 manual/signal.texi   |  33 ++++----
 manual/socket.texi   |  42 +++++-----
 manual/startup.texi  |   2 +
 manual/stdio.texi    |  59 ++++++++++++--
 manual/string.texi   |   4 +-
 manual/summary.awk   |   3 +-
 manual/sysinfo.texi  |  58 +++++++++++++-
 manual/syslog.texi   |  68 ++++++++++++++++-
 manual/terminal.texi |  37 ++++-----
 manual/time.texi     |  14 +++-
 manual/users.texi    |  41 ++++------
 31 files changed, 1128 insertions(+), 242 deletions(-)
 create mode 100755 manual/check-stds.pl

-- 
2.10.0