diff options
Diffstat (limited to 'newlib/HOWTO')
| -rw-r--r-- | newlib/HOWTO | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/newlib/HOWTO b/newlib/HOWTO index 63616200d..c5754e5b8 100644 --- a/newlib/HOWTO +++ b/newlib/HOWTO @@ -59,18 +59,17 @@ and PORTABILITY. BUGS and SEEALSO 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 -makefiles as either CHEWOUT_FILES in the libc makefiles or chobj in the libm -makefiles. These .def files need to be included into an appropriate .tex -file for inclusion in the manuals (one each for libc and libm). Pay special -attention under libc, as the manual is arranged by header file name, but not -all header files are represented by directories (e.g. wcsftime.c is found -under libc/time, but goes under wchar.h in the manual.) +makefiles as CHEWOUT_FILES. These .def files need to be included into an +appropriate .tex file for inclusion in the manuals (one each for libc and libm). +Pay special attention under libc, as the manual is arranged by header file name, +but not all header files are represented by directories (e.g. wcsftime.c is +found under libc/time, but goes under wchar.h in the manual.) In summary, to add new documentation: 1. Add properly-formatted comments to source file (e.g. src.c); -2. add "chewout" file to list in Makefile.am (CHEWOUT_FILES in libc or chobj in - libm) (e.g. src.def), re-generate Makefile.in; +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; 4. make ChangeLog entry and generate patch. |