From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 86301 invoked by alias); 29 Dec 2019 17:12:02 -0000 Mailing-List: contact newlib-cvs-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: newlib-cvs-owner@sourceware.org Received: (qmail 86259 invoked by uid 9795); 29 Dec 2019 17:12:01 -0000 Date: Sun, 29 Dec 2019 17:12:00 -0000 Message-ID: <20191229171201.86257.qmail@sourceware.org> Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: Jon TURNEY To: newlib-cvs@sourceware.org Subject: [newlib-cygwin] doc: add more details about adding documentation to HOWTO X-Act-Checkin: newlib-cygwin X-Git-Author: Jon Turney X-Git-Refname: refs/heads/master X-Git-Oldrev: 3bc79b275ef2ac0a2bb6805183e62baa29b6a1a2 X-Git-Newrev: 7685c4dd6c77a4177dfbbf91ac255053171cc41f X-SW-Source: 2019-q4/txt/msg00033.txt.bz2 https://sourceware.org/git/gitweb.cgi?p=newlib-cygwin.git;h=7685c4dd6c77a4177dfbbf91ac255053171cc41f commit 7685c4dd6c77a4177dfbbf91ac255053171cc41f Author: Jon Turney Date: Wed Dec 18 14:03:42 2019 +0000 doc: add more details about adding documentation to HOWTO Add a little more detail to the checklist for adding documentation Also update the list of supported sections Diff: --- newlib/HOWTO | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/newlib/HOWTO b/newlib/HOWTO index bb49e79..3a214ed 100644 --- a/newlib/HOWTO +++ b/newlib/HOWTO @@ -49,7 +49,8 @@ For an example of this kind of usage, see libm/common/s_logb.c. If writing a new function that requires documentation, the required sections are FUNCTION, INDEX, SYNOPSIS, DESCRIPTION, RETURNS, -and PORTABILITY. BUGS and SEEALSO should be added as appropriate. +and PORTABILITY. BUGS, NOTES, SEEALSO and WARNINGS should be added as +appropriate. Source files which contain documentation are processed into ".def" files with the extracted information. These .def files are noted in the @@ -64,7 +65,8 @@ In summary, to add new documentation: 1. Add properly-formatted comments to source file (e.g. src.c); 2. add "chewout" file to CHEWOUT_FILES list in Makefile.am (e.g. src.def), re-generate Makefile.in; -3. add file to something.tex; +3. @include that .def file in the appropriate .tex file, add texinfo menu + entries that reference the @node(s) in that .def file; 4. make ChangeLog entry and generate patch. EL/IX (ELIX_LEVEL_n, ELIX_n_SOURCES)