Welcome to mirror list, hosted at ThFree Co, Russian Federation.

cygwin.com/git/newlib-cygwin.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Johnston <jjohnstn@redhat.com>2015-11-03 02:00:28 +0300
committerJeff Johnston <jjohnstn@redhat.com>2015-11-03 02:02:39 +0300
commit06312793945e184036b9491767b9eacac9be3890 (patch)
treeb8e4fbafe646bf9b186d1b93ff56d0f7c7794658 /newlib/HOWTO
parent53617ce4e634bd6f67e6e08939518dba77dee3f1 (diff)
Move duplicated documentation rules to Makefile.shared
- Also, harmonize libm to use CHEWOUT_FILES like libc, rather than chobj. Update documentation appropriately. * HOWTO: Update. * Makefile.shared: Move documentation rules to here... * libc/argz/Makefile.am: ... from here ... * libc/ctype/Makefile.am: ... and here. * libc/errno/Makefile.am: Ditto. * libc/iconv/Makefile.am: Ditto. * libc/iconv/ccs/Makefile.am : Ditto. * libc/iconv/ces/Makefile.am: Ditto. * libc/iconv/lib/Makefile.am: Ditto. * libc/locale/Makefile.am: Ditto. * libc/misc/Makefile.am: Ditto. * libc/posix/Makefile.am: Ditto. * libc/reent/Makefile.am: Ditto. * libc/search/Makefile.am: Ditto. * libc/stdio/Makefile.am: Ditto. * libc/stdio64/Makefile.am: Ditto. * libc/stdlib/Makefile.am : Ditto. * libc/string/Makefile.am: Ditto. * libc/syscalls/Makefile.am: Ditto. * libc/time/Makefile.am : Ditto. * libc/unix/Makefile.am: Ditto. * libc/xdr/Makefile.am: Ditto. * libm/common/Makefile.am: Ditto. * libm/complex/Makefile.am: Ditto. * libm/math/Makefile.am: Ditto. * libm/mathfp/Makefile.am: Ditto.
Diffstat (limited to 'newlib/HOWTO')
-rw-r--r--newlib/HOWTO15
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.