JehanneOS
/
newlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
Jon Turney 2019-12-18 14:03:42 +00:00
parent 3bc79b275e
commit 7685c4dd6c
No known key found for this signature in database
GPG Key ID: C7C86F0370285C81
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
newlib/HOWTO
View File

@ -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)