public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
From: Rical Jasan <ricaljasan@pacific.net>
To: libc-alpha@sourceware.org
Cc: Michael Kerrisk <mtk.manpages@gmail.com>,
	"Carlos O'Donell" <carlos@redhat.com>
Subject: [PATCH 0/3] manual: Header & Standards Cleanup
Date: Wed, 23 Nov 2016 06:38:00 -0000	[thread overview]
Message-ID: <20161123063807.14845-1-ricaljasan@pacific.net> (raw)

[-- Attachment #1: Type: text/plain, Size: 2166 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
  @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

             reply	other threads:[~2016-11-23  6:38 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-23  6:38 Rical Jasan [this message]
2016-11-23  6:38 ` [PATCH 3/3] manual: Add new header and standards annotations Rical Jasan
2016-11-23 17:42   ` Joseph Myers
2016-11-24 10:22     ` Rical Jasan
2016-11-24 13:37       ` Joseph Myers
2016-11-25  5:59         ` Rical Jasan
2016-11-25 14:53           ` Joseph Myers
2016-11-25 15:09             ` Joseph Myers
2016-11-30 10:39             ` Rical Jasan
2016-11-30 10:45               ` Florian Weimer
2016-11-30 12:50                 ` Joseph Myers
2016-12-02 11:54                   ` Rical Jasan
2016-12-02 13:56                     ` Joseph Myers
2016-12-05  7:59                       ` Rical Jasan
2016-11-30 12:38               ` Joseph Myers
2016-12-05  5:33         ` Rical Jasan
2016-12-05 18:22           ` Joseph Myers
2016-12-06 10:57         ` Rical Jasan
2016-12-06 15:59           ` Joseph Myers
2016-12-06 16:36           ` Zack Weinberg
2016-11-25  7:36     ` Rical Jasan
2016-11-25 16:17       ` Joseph Myers
2016-11-30 10:46         ` Rical Jasan
2016-11-30 12:52           ` Joseph Myers
2016-11-23  6:38 ` [PATCH 2/3] manual: Convert @tables of variables to @vtables Rical Jasan
2016-11-23  6:38 ` [PATCH 1/3] manual: Refactor header and standards annotations Rical Jasan
2016-11-23 17:31   ` Joseph Myers
2016-11-24  9:34     ` Rical Jasan
2016-11-24 13:17       ` Joseph Myers
2016-11-25  3:44         ` Rical Jasan
2016-11-25 14:25           ` Joseph Myers
2016-11-30  8:58             ` Rical Jasan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20161123063807.14845-1-ricaljasan@pacific.net \
    --to=ricaljasan@pacific.net \
    --cc=carlos@redhat.com \
    --cc=libc-alpha@sourceware.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).