diff options
| author | Jon Turney <jon.turney@dronecode.org.uk> | 2019-12-18 17:03:42 +0300 |
|---|---|---|
| committer | Jon Turney <jon.turney@dronecode.org.uk> | 2019-12-29 20:10:15 +0300 |
| commit | 7685c4dd6c77a4177dfbbf91ac255053171cc41f (patch) | |
| tree | 0a8fa6b1c0b4d866dfc370c931f6aa64696676af /newlib/HOWTO | |
| parent | 3bc79b275ef2ac0a2bb6805183e62baa29b6a1a2 (diff) | |
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
Diffstat (limited to 'newlib/HOWTO')
| -rw-r--r-- | newlib/HOWTO | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/newlib/HOWTO b/newlib/HOWTO index bb49e79dd..3a214edf4 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) |