public inbox for newlib-cvs@sourceware.org
help / color / mirror / Atom feed
* [newlib-cygwin] doc: add more details about adding documentation to HOWTO
@ 2019-12-29 17:12 Jon TURNEY
0 siblings, 0 replies; only message in thread
From: Jon TURNEY @ 2019-12-29 17:12 UTC (permalink / raw)
To: newlib-cvs
https://sourceware.org/git/gitweb.cgi?p=newlib-cygwin.git;h=7685c4dd6c77a4177dfbbf91ac255053171cc41f
commit 7685c4dd6c77a4177dfbbf91ac255053171cc41f
Author: Jon Turney <jon.turney@dronecode.org.uk>
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)
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2019-12-29 17:12 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-29 17:12 [newlib-cygwin] doc: add more details about adding documentation to HOWTO Jon TURNEY
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).