This is the mail archive of the
newlib@sourceware.org
mailing list for the newlib project.
[PATCH 00/11] Documentation fixes
- From: Jon TURNEY <jon dot turney at dronecode dot org dot uk>
- To: newlib at sourceware dot org
- Cc: Jon TURNEY <jon dot turney at dronecode dot org dot uk>
- Date: Tue, 23 Jun 2015 20:49:13 +0100
- Subject: [PATCH 00/11] Documentation fixes
- Authentication-results: sourceware.org; auth=none
Cygwin has a package containing manpages for newlib which are generated from the
.info files by a perl script, which gives pretty poor results.
I've been looking at doing that in a better way, so I made an alternative to the
makedoc tool, which generates DocBook XML rather than .texinfo, which can then
be processed into manpages and other formats
I'm not sure if that's going to be a completely workable approach, and is
unlikely to be suitable for upstreaming, but while working on it I've found a
few errors and inconsistencies in the newlib documentation along the way. Here
are some patches to fix those issues.
Jon TURNEY (11):
Fix makedoc markup used in texinfo source
Fix some mangled makedoc markup
Remove stray punctuation in ANSI_SYNOPSIS prototypes
Correct a non-ANSI prototype in SYNOPSIS
Fix SYNOPSIS prototypes without marked up parameter names
Fix an inconsistent use of '.' in FUNCTION
Fix typo-ed function names in efgcvt.c documentation
Fix mismatched parentheses in documentation.
Don't chew files which contain no documentation markup
Use makedoc output files which are generated but aren't included
Use source files which have makedoc markup, but aren't processed or
included.
newlib/ChangeLog | 71 +++++++++++++++++++++++++++++++++++++++++
newlib/libc/ctype/Makefile.am | 1 +
newlib/libc/ctype/ctype.tex | 4 +++
newlib/libc/locale/locale.c | 2 +-
newlib/libc/locale/locale.tex | 3 +-
newlib/libc/posix/Makefile.am | 3 +-
newlib/libc/posix/posix.tex | 3 ++
newlib/libc/signal/signal.tex | 2 +-
newlib/libc/stdio/Makefile.am | 2 --
newlib/libc/stdio/fgetwc.c | 2 +-
newlib/libc/stdio/fread.c | 2 +-
newlib/libc/stdio/getchar_u.c | 2 +-
newlib/libc/stdio/stdio.tex | 2 +-
newlib/libc/stdio64/Makefile.am | 1 +
newlib/libc/stdio64/fdopen64.c | 2 +-
newlib/libc/stdio64/stdio64.tex | 6 +++-
newlib/libc/stdlib/Makefile.am | 1 -
newlib/libc/stdlib/efgcvt.c | 4 +--
newlib/libc/stdlib/itoa.c | 2 +-
newlib/libc/stdlib/llabs.c | 2 +-
newlib/libc/stdlib/stdlib.tex | 10 +++++-
newlib/libc/stdlib/wcsnrtombs.c | 8 ++---
newlib/libc/string/Makefile.am | 2 +-
newlib/libc/string/strings.tex | 12 +++++++
newlib/libc/string/wcpcpy.c | 2 +-
newlib/libc/string/wcscpy.c | 2 +-
newlib/libc/time/tzset.c | 4 +--
newlib/libm/common/s_exp10.c | 2 +-
newlib/libm/common/s_nan.c | 4 +--
newlib/libm/common/s_pow10.c | 2 +-
newlib/libm/math/math.tex | 6 ++++
31 files changed, 140 insertions(+), 31 deletions(-)
--
2.1.4