This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH 0/3] manual: Header & Standards Cleanup
- From: Rical Jasan <ricaljasan at pacific dot net>
- To: libc-alpha at sourceware dot org
- Cc: Michael Kerrisk <mtk dot manpages at gmail dot com>, "Carlos O'Donell" <carlos at redhat dot com>
- Date: Tue, 22 Nov 2016 22:38:04 -0800
- Subject: [PATCH 0/3] manual: Header & Standards Cleanup
- Authentication-results: sourceware.org; auth=none
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
@comment STANDARD
@(def|item|...)
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.
---
manual/argp.texi | 28 +++++++++
manual/arith.texi | 28 +++++++++
manual/creature.texi | 2 +
manual/filesys.texi | 52 ++++++++++++++--
manual/ipc.texi | 28 +++++++++
manual/lang.texi | 22 ++++++-
manual/llio.texi | 102 ++++++++++++++++++++++++++++---
manual/locale.texi | 168 ++++++++++++++++++++++++++++++++++++++++++++++++++-
manual/math.texi | 26 ++++++++
manual/memory.texi | 33 ++++++++--
manual/message.texi | 4 ++
manual/nss.texi | 12 +++-
manual/pattern.texi | 36 +++++++++++
manual/platform.texi | 20 ++++++
manual/process.texi | 16 +++--
manual/resource.texi | 53 ++++++++++------
manual/search.texi | 16 ++++-
manual/signal.texi | 12 ++++
manual/socket.texi | 3 +
manual/startup.texi | 2 +
manual/stdio.texi | 52 ++++++++++++++++
manual/string.texi | 2 +
manual/sysinfo.texi | 58 ++++++++++++++++--
manual/syslog.texi | 68 ++++++++++++++++++++-
manual/terminal.texi | 29 +++++----
manual/time.texi | 12 +++-
manual/users.texi | 14 +++--
27 files changed, 827 insertions(+), 71 deletions(-)
--
2.10.0