newlib-cygwin/newlib/libc/misc/misc.tex

@node Misc
@chapter Miscellaneous Macros and Functions
This chapter describes miscellaneous routines not covered elsewhere.

@menu 
* Function ffs::      Return first bit set in a word
* Function __retarget_lock_init::     Retargetable locking routines
* Function unctrl::   Return printable representation of a character
@end menu

@page
@include misc/ffs.def

@page
@include misc/lock.def

@page
@include misc/unctrl.def
import newlib-2000-02-17 snapshot 2000-02-17 19:39:52 +00:00			`@node Misc`
			`@chapter Miscellaneous Macros and Functions`
			`This chapter describes miscellaneous routines not covered elsewhere.`

			`@menu`
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 00:01:23 -05:00			`* Function ffs:: Return first bit set in a word`
			`* Function __retarget_lock_init:: Retargetable locking routines`
			`* Function unctrl:: Return printable representation of a character`
import newlib-2000-02-17 snapshot 2000-02-17 19:39:52 +00:00			`@end menu`

2002-07-16 Jeff Johnston <jjohnstn@redhat.com> * libc/Makefile.am (stmp-extra): New target to set makeinfo flag if LIBC_EXTRA_LIB is present. * libc/Makefile.in: Regenerated. * libc/libc.texinfo: Add blank line. * libc/argz/Makefile.am: Add doc support. * libc/search/Makefile.am: Ditto. * libc/argz/Makefile.in: Regenerated. * libc/search/Makefile.in: Ditto. * libc/misc/misc.tex: Add ffs function. * libc/stdio/ftell.c: Fix missing doc delimeter in description. 2002-07-16 15:30:32 +00:00			`@page`
			`@include misc/ffs.def`

Allow locking routine to be retargeted At the moment when targeting bare-metal targets or systems without definition for the locking primitives newlib, uses dummy empty macros. This has the advantage of reduced size and faster implementation but does not allow the application to retarget the locking routines. Retargeting is useful for a single toolchain to support multiple systems since then it's only at link time that you know which system you are targeting. This patch adds a new configure option --enable-newlib-retargetable-locking to use dummy empty functions instead of dummy empty macros. The default is to keep the current behavior to not have any size or speed impact on targets not interested in this feature. To allow for any size of lock, the _LOCK_T type is changed into pointer to struct _lock and the _init function are tasked with allocating the locks. The platform being targeted must provide the static locks. A dummy implementation of the locking routines and static lock is provided for single-threaded applications to link successfully out of the box. To ensure that the behavior is consistent (either no locking whatsoever or working locking), the dummy implementation is strongly defined such that a partial retargeting will cause a doubly defined link error. Indeed, the linker will only pull in the file providing the dummy implementation if it cannot find an implementation for one of the routine or lock. 2016-10-25 17:38:19 +01:00			`@page`
			`@include misc/lock.def`

import newlib-2000-02-17 snapshot 2000-02-17 19:39:52 +00:00			`@page`
			`@include misc/unctrl.def`