]> sourceware.org Git - newlib-cygwin.git/commitdiff
doc: add more details about adding documentation to HOWTO
authorJon Turney <jon.turney@dronecode.org.uk>
Wed, 18 Dec 2019 14:03:42 +0000 (14:03 +0000)
committerJon Turney <jon.turney@dronecode.org.uk>
Sun, 29 Dec 2019 17:10:15 +0000 (17:10 +0000)
Add a little more detail to the checklist for adding documentation
Also update the list of supported sections

newlib/HOWTO

index bb49e79dda94b76cbf50412040804239de151c88..3a214edf46a4fdcdb292f4b691390a6e24650bb0 100644 (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)
This page took 0.032039 seconds and 5 git commands to generate.