libs/newlib-cygwin
libs
/
newlib-cygwin
mirror of git://sourceware.org/git/newlib-cygwin.git
4
0
Fork 0
Code Issues Projects Releases Wiki Activity
newlib-cygwin/newlib/doc/doc.str

161 lines
2.2 KiB
Plaintext
Raw Normal View History

import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
: nokill_bogus_lines ;
: ENDDD
skip_past_newline
;
: TABLE
skip_past_newline
"@table @code\n" catstr
;
: ENDTABLE
skip_past_newline
"@end table\n"
catstr
;
: QUICKREF
skip_past_newline
makedoc: make errors visible Discard QUICKREF sections, rather than writing them to stderr Discard MATHREF sections, rather than discarding as an error Pass NOTES sections through to texinfo, rather than discarding as an error Don't redirect makedoc stderr to .ref file Remove makedoc output on error Remove .ref files from CLEANFILES Regenerate Makefile.ins Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2017-12-05 02:08:28 +08:00
;
: MATHREF
skip_past_newline
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
;
: EXAMPLE
skip_past_newline
get_stuff_in_command nokill_bogus_lines translatecomments
courierize catstr
;
: INODE
"@node " catstr skip_past_newline copy_past_newline catstr
;
: CODE_FRAGMENT
EXAMPLE
;
: SYNOPSIS
skip_past_newline
"@strong{Synopsis}\n" catstr
"@example\n" catstr
get_stuff_in_command
do_fancy_stuff
nokill_bogus_lines
indent
catstr
"@end example\n" catstr
;
: ANSI_SYNOPSIS
skip_past_newline
"@strong{Synopsis}\n" catstr
"@example\n" catstr
get_stuff_in_command
do_fancy_stuff
nokill_bogus_lines
indent
catstr
"@end example\n" catstr
makedoc: warn about some obsolete and deprecated commands To follow up the thread starting at [1], since all uses of TRAD_SYNOPSIS have been removed, and all uses of ANSI_SYNOPSIS have been renamed to SYNOPSIS, we can now warn about the use of these. [1] https://sourceware.org/ml/newlib/2017/msg01182.html Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2017-12-06 02:40:44 +08:00
"ANSI_SYNOPSIS is deprecated, use SYNOPSIS instead" warn
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
;
: TRAD_SYNOPSIS
skip_past_newline
makedoc: warn about some obsolete and deprecated commands To follow up the thread starting at [1], since all uses of TRAD_SYNOPSIS have been removed, and all uses of ANSI_SYNOPSIS have been renamed to SYNOPSIS, we can now warn about the use of these. [1] https://sourceware.org/ml/newlib/2017/msg01182.html Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2017-12-06 02:40:44 +08:00
"TRAD_SYNOPSIS is obsolete and ignored" warn
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
;
: INDEX
"@findex " skip_past_newline copy_past_newline catstr catstr
;
: FUNCTION
newlib: docs: add "Function " to every function node When creating a split manual with one-node-per-page, the main index.html ends up getting clobbered by the page for the index() function because it uses "@node index" which, for html, also creates an index.html page. To remedy this, add "Function " to every function node so now we output "Function-index.html" and avoid clobbering. It also namespaces every other function and helps make sure we don't clobber anything else. Otherwise, there isn't really much rendering difference as @node text is mostly internal. Node title text comes from @section instead.
2024-01-05 13:01:23 +08:00
"@node Function " - a
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
skip_past_newline
copy_past_newline
dup - a x x
get_stuff_in_angle -a x y
swap
do_fancy_stuff
"@section " - a x x b
swap
remchar
"\n" - a x b x c
catstr catstr catstr catstr catstr
;
: bodytext
get_stuff_in_command
bulletize
courierize
do_fancy_stuff
catstr
Manuals failing to build on Ubuntu LTS 14.04 On 11/08/2015 11:08, Andre Vieira wrote: > On 10/08/15 14:38, Jon TURNEY wrote: >> On 07/08/2015 11:13, Andre Vieira wrote: >>> Building the manuals on Ubuntu LTS 14.04 (64-bit) using pdfTeX >>> 3.1415926-2.5-1.40.14 (TeX Live 2013/Debian) is failing with the >>> following error: >>> "Transcript written on libc.log. >>> /usr/bin/texi2dvi: pdfetex exited with bad status, quitting." >>> >>> libc.log complaints about the following: >>> >>> You can't use `@unskip' in vertical mode. >>> [...] >>> >>> This code has been around for a while, so it might have to do with a >>> change in pdfTex? So it seems this problem has been around for a while, and looks like it is due to a change in texi2dvi in texinfo 5.0 or late 4.x, see [1]. I guess it's not very noticeable since it only occurs when doing 'make dvi', which doesn't happen by default. Attached is a different and perhaps cleaner workaround to the one in that thread. [1] https://sourceware.org/ml/newlib/2013/msg00057.html From 4d386b5900b6c68e022004b447faa696be5ff8c7 Mon Sep 17 00:00:00 2001 From: Jon TURNEY <jon.turney@dronecode.org.uk> Date: Tue, 11 Aug 2015 14:46:39 +0100 Subject: [PATCH] Use '@sp 1' rather than '@*' to workaround a change in texi2dvi. Since about TexInfo 5.0, using '@*' immediately after a table causes a 'You can't use `@unskip' in vertical mode' error. See https://sourceware.org/ml/newlib/2013/msg00057.html Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
2015-08-11 21:55:23 +08:00
"@sp 1\n" catstr
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
;
: asection
skip_past_newline
catstr
copy_past_newline
do_fancy_stuff catstr
bodytext
;
: SECTION
"@section " asection ;
: SUBSECTION
"@section " asection ;
: SUBSUBSECTION
"@subsection " asection ;
: subhead
skip_past_newline
bodytext
;
: DESCRIPTION
"@strong{Description}@*\n" catstr subhead ;
: RETURNS
"@strong{Returns}@*\n" catstr subhead ;
: ERRORS
"@strong{Errors}@*\n" catstr subhead ;
: PORTABILITY
"@strong{Portability}@*\n" catstr subhead ;
2009-03-25 Craig Howland <howland@LGSInnovations.com> * libc/include/math.h: (llround, llroundf): Declare. * libm/common/s_llround.c: New file, implementing llround(). * libm/common/sf_llround.c: New file, implementing llroundf(). * libm/common/sf_lround.c: Remove spurious cast in _DOUBLE_IS_32BITS version of function. * libm/common/sf_lrint.c: Ditto. * libm/common/sf_logb.c: Corrected return for subnormal argument by replacing existing function with a version created from sf_ilogb.c. * libm/common/s_logb.c: Ditto, except starting point s_ilogb.c. Also added documentation for logb() and logbf(). * libm/common/s_signbit.c: Add signbit() documentation. * libm/common/s_log2.c: Update return values to match what w_log2.c has, since log2 uses log(); add note about being derived instead of direct. * libm/common/sf_fma.c: Add casts to attempt to get correct results, as well as comments pointing out problems with the implementation. * libm/common/s_fma.c: Add fma() and fmaf() documentation. * libm/common/sf_remquo.c: Incorrect quotient returns for large values corrected by discarding existing function and replacing with Sun verion, with some enhancements. * libm/common/s_remquo.c: Ditto. Add remquo() and remquof() documentation. * libm/common/s_fmax.c: Add fmax() and fmaxf() documentation. * libm/common/s_fmin.c: Add fmin() and fminf() documentation. * libm/common/s_fdim.c: Return NAN for NAN arg, add fdim() and fdimf() documentation. * libm/common/sf_fdim.c: Return NAN for NAN arg, HUGE_VALF for inf arg. * libm/common/s_trunc.c: Add trunc() and truncf() documentation. * libm/common/s_rint.c: Add rint() and rintf() documentation. * libm/common/s_round.c: Add round() and roundf() documentation. * libm/common/s_scalbn.c: Add scalbln() and scalblnf() documentation. * libm/common/s_infinity.c: Add infinity() and infinityf() documentation. * libm/common/s_lround.c: Add lround(), lroundf(), llround(), and llroundf() documentation. * libm/common/s_lrint.c: Add lrint(), lrintf(), llrint(), and llrintf() documentation. * libm/common/isgreater.c: New file for documenting math.h function-like macros isgreater(), isgreaterequal(), isless(), islessequal(), islessgreater(), and isunordered(). * libm/common/s_isnan.c: Add documentation for function-like macros fpclassify(), isfinite(), isinf(), isnan(), and isnormal(). * libm/common/s_nearbyint.c: Add nearbyint() and nearbyintf() documentation. * libm/common/Makefile.am: Add s_llround.c (src); sf_llround.c (fsrc); s_fdim.def, s_fma.def, s_fmax.def, s_fmin.def, s_logb.def, s_lrint.def, s_lround.def, s_nearbyint.def, s_remquo.def, s_rint.def, s_round.def, s_signbit.def, s_trunc.def, and isgreater.def (chobj); re-name all existing chew files (chobj) to match source file base names (put in underscores), delete all special targets for chew files (leaving all to be generated by rule). * libm/common/Makefile.in: regenerate. * libm/math/w_exp2.c: Add "base 2" to documentation description (and delete TRAD_SYNOPSIS). * libm/math/w_gamma.c: Add tgamma() and tgammaf() documentation, along with some history behind the function names. * libm/math/math.tex: Add includes for newly-added documentation (see .def additions to common/Makefile.am and math/Makefile.am in this ChangeLog list), adjusted existing .def file names to match source file base names (added underscores); add mention of HUGE_VALF; rename "Version of library" section to "Error Handling" and add some text about floating-point exception; added section "Standards Compliance And Portability". * libm/math/Makefile.am: Add w_exp2.def (chobj); re-name all existing chew files (chobj) to match source file base names, delete all special targets for chew files (leaving all to be generated by rule). * libm/math/Makefile.in: regenerated * doc/makedoc.c: Change silent ignoring of commands < 5 characters to a failure when reading macro file for commands < 4 characters; add -v (verbose) option for printing some debugging information; get rid of spurious translation of "@*" to "*" (no source files used @*, so no existing doc pages were affected); clean up some compiler warnings. * doc/doc.str: add BUGS and SEEALSO sections (to match texi2pod.pl which has them); Remove ITEM command (redundant with makedoc built-in "o", not used in any present source file so nothing is lost, anyway). * HOWTO: New file to hold information for maintainers regarding how to do things. Initial sections on documentation and ELIX levels.
2009-03-26 05:16:04 +08:00
: BUGS
"@strong{Bugs}@*\n" catstr subhead ;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
: WARNINGS
"@strong{Warnings}@*\n" catstr subhead ;
2009-03-25 Craig Howland <howland@LGSInnovations.com> * libc/include/math.h: (llround, llroundf): Declare. * libm/common/s_llround.c: New file, implementing llround(). * libm/common/sf_llround.c: New file, implementing llroundf(). * libm/common/sf_lround.c: Remove spurious cast in _DOUBLE_IS_32BITS version of function. * libm/common/sf_lrint.c: Ditto. * libm/common/sf_logb.c: Corrected return for subnormal argument by replacing existing function with a version created from sf_ilogb.c. * libm/common/s_logb.c: Ditto, except starting point s_ilogb.c. Also added documentation for logb() and logbf(). * libm/common/s_signbit.c: Add signbit() documentation. * libm/common/s_log2.c: Update return values to match what w_log2.c has, since log2 uses log(); add note about being derived instead of direct. * libm/common/sf_fma.c: Add casts to attempt to get correct results, as well as comments pointing out problems with the implementation. * libm/common/s_fma.c: Add fma() and fmaf() documentation. * libm/common/sf_remquo.c: Incorrect quotient returns for large values corrected by discarding existing function and replacing with Sun verion, with some enhancements. * libm/common/s_remquo.c: Ditto. Add remquo() and remquof() documentation. * libm/common/s_fmax.c: Add fmax() and fmaxf() documentation. * libm/common/s_fmin.c: Add fmin() and fminf() documentation. * libm/common/s_fdim.c: Return NAN for NAN arg, add fdim() and fdimf() documentation. * libm/common/sf_fdim.c: Return NAN for NAN arg, HUGE_VALF for inf arg. * libm/common/s_trunc.c: Add trunc() and truncf() documentation. * libm/common/s_rint.c: Add rint() and rintf() documentation. * libm/common/s_round.c: Add round() and roundf() documentation. * libm/common/s_scalbn.c: Add scalbln() and scalblnf() documentation. * libm/common/s_infinity.c: Add infinity() and infinityf() documentation. * libm/common/s_lround.c: Add lround(), lroundf(), llround(), and llroundf() documentation. * libm/common/s_lrint.c: Add lrint(), lrintf(), llrint(), and llrintf() documentation. * libm/common/isgreater.c: New file for documenting math.h function-like macros isgreater(), isgreaterequal(), isless(), islessequal(), islessgreater(), and isunordered(). * libm/common/s_isnan.c: Add documentation for function-like macros fpclassify(), isfinite(), isinf(), isnan(), and isnormal(). * libm/common/s_nearbyint.c: Add nearbyint() and nearbyintf() documentation. * libm/common/Makefile.am: Add s_llround.c (src); sf_llround.c (fsrc); s_fdim.def, s_fma.def, s_fmax.def, s_fmin.def, s_logb.def, s_lrint.def, s_lround.def, s_nearbyint.def, s_remquo.def, s_rint.def, s_round.def, s_signbit.def, s_trunc.def, and isgreater.def (chobj); re-name all existing chew files (chobj) to match source file base names (put in underscores), delete all special targets for chew files (leaving all to be generated by rule). * libm/common/Makefile.in: regenerate. * libm/math/w_exp2.c: Add "base 2" to documentation description (and delete TRAD_SYNOPSIS). * libm/math/w_gamma.c: Add tgamma() and tgammaf() documentation, along with some history behind the function names. * libm/math/math.tex: Add includes for newly-added documentation (see .def additions to common/Makefile.am and math/Makefile.am in this ChangeLog list), adjusted existing .def file names to match source file base names (added underscores); add mention of HUGE_VALF; rename "Version of library" section to "Error Handling" and add some text about floating-point exception; added section "Standards Compliance And Portability". * libm/math/Makefile.am: Add w_exp2.def (chobj); re-name all existing chew files (chobj) to match source file base names, delete all special targets for chew files (leaving all to be generated by rule). * libm/math/Makefile.in: regenerated * doc/makedoc.c: Change silent ignoring of commands < 5 characters to a failure when reading macro file for commands < 4 characters; add -v (verbose) option for printing some debugging information; get rid of spurious translation of "@*" to "*" (no source files used @*, so no existing doc pages were affected); clean up some compiler warnings. * doc/doc.str: add BUGS and SEEALSO sections (to match texi2pod.pl which has them); Remove ITEM command (redundant with makedoc built-in "o", not used in any present source file so nothing is lost, anyway). * HOWTO: New file to hold information for maintainers regarding how to do things. Initial sections on documentation and ELIX levels.
2009-03-26 05:16:04 +08:00
: SEEALSO
"@strong{See Also}@*\n" catstr subhead ;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
makedoc: make errors visible Discard QUICKREF sections, rather than writing them to stderr Discard MATHREF sections, rather than discarding as an error Pass NOTES sections through to texinfo, rather than discarding as an error Don't redirect makedoc stderr to .ref file Remove makedoc output on error Remove .ref files from CLEANFILES Regenerate Makefile.ins Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2017-12-05 02:08:28 +08:00
: NOTES
"@strong{Notes}@*\n" catstr subhead ;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
: INTERNAL_FUNCTION
makedoc: Fix INTERNAL(|DEFINITION|FUNCTION) command definitions The unused INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL commands are defined in terms of the non-existent built-in 'func' This causes every single invocation of makedoc to output "Can't find func" three times, as it parses doc.str. This is normally un-noticed because makedoc's stderr is redirected to a .ref file. Fix these unused command definitions to something with equivalent lack of effect, but without generating an error. 2015-11-06 Jon Turney <jon.turney@dronecode.org.uk> * doc/doc.str: Fix INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL. Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2015-10-25 23:25:00 +08:00
;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
makedoc: Fix INTERNAL(|DEFINITION|FUNCTION) command definitions The unused INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL commands are defined in terms of the non-existent built-in 'func' This causes every single invocation of makedoc to output "Can't find func" three times, as it parses doc.str. This is normally un-noticed because makedoc's stderr is redirected to a .ref file. Fix these unused command definitions to something with equivalent lack of effect, but without generating an error. 2015-11-06 Jon Turney <jon.turney@dronecode.org.uk> * doc/doc.str: Fix INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL. Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2015-10-25 23:25:00 +08:00
: INTERNAL_DEFINITION
;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
: INTERNAL
makedoc: Fix INTERNAL(|DEFINITION|FUNCTION) command definitions The unused INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL commands are defined in terms of the non-existent built-in 'func' This causes every single invocation of makedoc to output "Can't find func" three times, as it parses doc.str. This is normally un-noticed because makedoc's stderr is redirected to a .ref file. Fix these unused command definitions to something with equivalent lack of effect, but without generating an error. 2015-11-06 Jon Turney <jon.turney@dronecode.org.uk> * doc/doc.str: Fix INTERNAL_DEFINITION, INTERNAL_FUNCTION and INTERNAL. Signed-off-by: Jon Turney <jon.turney@dronecode.org.uk>
2015-10-25 23:25:00 +08:00
;
import newlib-2000-02-17 snapshot
2000-02-18 03:39:52 +08:00
: TYPEDEF
FUNCTION ;
: NEWPAGE
"@page\n" catstr subhead ;