From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 21412 invoked by alias); 23 Nov 2016 06:38:15 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Received: (qmail 21331 invoked by uid 89); 23 Nov 2016 06:38:14 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-4.4 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,RP_MATCHES_RCVD,SPF_PASS autolearn=ham version=3.3.2 spammy=Facilities, 2100, Hx-spam-relays-external:sk:mail.pa, H*RU:sk:mail.pa X-HELO: mail.pacific.net From: Rical Jasan To: libc-alpha@sourceware.org Cc: Michael Kerrisk , "Carlos O'Donell" Subject: [PATCH 0/3] manual: Header & Standards Cleanup Date: Wed, 23 Nov 2016 06:38:00 -0000 Message-Id: <20161123063807.14845-1-ricaljasan@pacific.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------2.10.0" X-Null-Tag: 46162419c10da66b29330877dc0498ec X-SW-Source: 2016-11/txt/msg00817.txt.bz2 This is a multi-part message in MIME format. --------------2.10.0 Content-Type: text/plain; charset=UTF-8; format=fixed Content-Transfer-Encoding: 8bit Content-length: 2166 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 --------------2.10.0--