which is a library of common routines intended to be shared at the
source level.
-Copyright @copyright{} 2004-2011 Free Software Foundation, Inc.
+Copyright @copyright{} 2004--2014 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@end ifnottex
@menu
-* Introduction::
+* Brief Overview::
+* Philosophy::
* Invoking gnulib-tool::
* Writing modules::
* Extending Gnulib::
@end macro
-@node Introduction
-@chapter Introduction
+@node Brief Overview
+@chapter Brief Overview
-Gnulib is a source code library. It provides basic functionalities to
-programs and libraries. Currently (as of October 2006) more than 30
-packages make use of Gnulib.
+Gnulib is a source code library that provides basic functionality to
+programs and libraries. Many software packages make use of Gnulib
+to avoid reinventing the portability wheel.
Resources:
@itemize
@item Gnulib is hosted at Savannah:
@url{http://savannah.gnu.org/projects/gnulib}. Get the sources
- through Git or CVS from there.
+ through Git from there.
@item The Gnulib home page:
@url{http://www.gnu.org/software/gnulib/}.
@end itemize
+@include gnulib-readme.texi
+
+@node Philosophy
+@chapter Philosophy
+
+Gnulib's design and development philosophy is organized around steady,
+collaborative, and open development of reusable modules that are
+suitable for a reasonably wide variety of platforms.
+
@menu
* Benefits::
* Library vs Reusable Code::
* Portability and Application Code::
+* Target Platforms::
* Modules::
* Various Kinds of Modules::
* Collaborative Development::
file (.h file) and implemented in one or more implementation files (.c files).
The separation has the effect that users of your module need to read only
the contents of the .h file and the module description in order to understand
-what the module is about and how to use it - not the entire implementation.
+what the module is about and how to use it---not the entire implementation.
Furthermore, users of your module don't need to repeat the declarations of
the functions in their code, and are likely to receive notification through
compiler errors if you make incompatible changes to the API (like, adding a
@code{--avoid} or it is marked as obsolete and the option
@code{--with-obsolete} is not given.
-A test modules @code{foo-tests} implicity depends on the corresponding non-test
+A test modules @code{foo-tests} implicitly depends on the corresponding non-test
module @code{foo}. @code{foo} implicitly depends on @code{foo-tests} if the
latter exists and if the option @code{--with-tests} has been given.
depend on tests modules. (Recall that tests modules are built in a separate
directory.)
+Each listed required module may be declared a conditional dependency. This
+is indicated by placing the condition for the dependency on the same line,
+enclosed in brackets, after the name of the required module. The condition
+is a shell expression that is run after the module's @code{configure.ac}
+statements. For example:
+@smallexample
+strtoull [test $ac_cv_func_strtoumax = no]
+@end smallexample
+
+Lines starting with @code{#} are recognized as comments and are ignored.
+
@item configure.ac-early
This field contains @file{configure.ac} stuff (Autoconf macro invocations and
shell statements) that are logically placed early in the @file{configure.ac}
The body of the test, then, contains many @code{ASSERT} invocations. When
a test fails, the @code{ASSERT} macro prints the line number of the failing
-statement, thus giving you as a developer a idea which part of the test
+statement, thus giving you, the developer, an idea of which part of the test
failed, even when you don't have access to the machine where the test failed
and the reporting user cannot run a debugger.
release that is made for the general public.
@end table
-@code{gnulib-tool --import} will not include tests marked with these
-attributes by default. When @code{gnulib-tool} is invoked with one
+@code{gnulib-tool --import --with-tests} will not include tests marked with
+these attributes by default. When @code{gnulib-tool} is invoked with one
of the options @code{--with-c++-tests}, @code{--with-longrunning-tests},
@code{--with-privileged-tests}, @code{--with-unportable-tests}, it
will include tests despite the corresponding special status attribute.
When @code{gnulib-tool} receives the option @code{--with-all-tests},
it will include all tests regardless of their status attributes.
-@code{gnulib-tool --create-testdir} and
-@code{gnulib-tool --create-megatestdir} by default include all tests of
-modules specified on the command line, regardless of their status
+@code{gnulib-tool --create-testdir --with-tests} and
+@code{gnulib-tool --create-megatestdir --with-tests} by default include all
+tests of modules specified on the command line, regardless of their status
attributes. Tests of modules occurring as dependencies are not included
by default if they have one of these status attributes. The options
@code{--with-c++-tests}, @code{--with-longrunning-tests},
an application layer that does not need to invoke POSIX functions and
an operating system interface layer that contains all the OS function
calls. In such a situation, you will want to turn on the namespace mode
-for the application layer --- to avoid many preprocessor macro
-definitions --- and turn it off for the OS interface layer --- to avoid
+for the application layer---to avoid many preprocessor macro
+definitions---and turn it off for the OS interface layer---to avoid
the drawback of the namespace mode, mentioned above.
@item Create gnulib directory
On a machine with recent automake, autoconf, m4 installed and with a
-gnulib git or cvs checkout (typically a Linux machine), use
+gnulib git checkout (typically a Linux machine), use
@example
gnulib-tool --create-megatestdir --with-tests --dir=...
@item Build modules
On the build machine, run ./do-autobuild (or "nohup ./do-autobuild").
-It creates a directory 'logs/' with a log file for each module.
+It creates a directory @file{logs/} with a log file for each module.
@item Submit build logs
* setjmp.h::
* signal.h::
* spawn.h::
+* stdalign.h::
* stdarg.h::
* stdbool.h::
* stddef.h::
* stdint.h::
* stdio.h::
* stdlib.h::
+* stdnoreturn.h::
* string.h::
* strings.h::
* stropts.h::
* tgmath.h::
* time.h::
* trace.h::
+* uchar.h::
* ucontext.h::
* ulimit.h::
* unistd.h::
@include posix-headers/setjmp.texi
@include posix-headers/signal.texi
@include posix-headers/spawn.texi
+@include posix-headers/stdalign.texi
@include posix-headers/stdarg.texi
@include posix-headers/stdbool.texi
@include posix-headers/stddef.texi
@include posix-headers/stdint.texi
@include posix-headers/stdio.texi
@include posix-headers/stdlib.texi
+@include posix-headers/stdnoreturn.texi
@include posix-headers/string.texi
@include posix-headers/strings.texi
@include posix-headers/stropts.texi
@include posix-headers/tgmath.texi
@include posix-headers/time.texi
@include posix-headers/trace.texi
+@include posix-headers/uchar.texi
@include posix-headers/ucontext.texi
@include posix-headers/ulimit.texi
@include posix-headers/unistd.texi
* aio_suspend::
* aio_write::
* alarm::
+* aligned_alloc::
* alphasort::
* asctime::
* asctime_r::
* bind::
* bsearch::
* btowc::
+* c16rtomb::
+* c32rtomb::
* cabs::
* cabsf::
* cabsl::
* malloc::
* mblen::
* mbrlen::
+* mbrtoc16::
+* mbrtoc32::
* mbrtowc::
* mbsinit::
* mbsnrtowcs::
* putwchar::
* pwrite::
* qsort::
+* quick_exit::
* raise::
* rand::
* rand_r::
@include posix-functions/aio_suspend.texi
@include posix-functions/aio_write.texi
@include posix-functions/alarm.texi
+@include posix-functions/aligned_alloc.texi
@include posix-functions/alphasort.texi
@include posix-functions/asctime.texi
@include posix-functions/asctime_r.texi
@include posix-functions/bind.texi
@include posix-functions/bsearch.texi
@include posix-functions/btowc.texi
+@include posix-functions/c16rtomb.texi
+@include posix-functions/c32rtomb.texi
@include posix-functions/cabs.texi
@include posix-functions/cabsf.texi
@include posix-functions/cabsl.texi
@include posix-functions/malloc.texi
@include posix-functions/mblen.texi
@include posix-functions/mbrlen.texi
+@include posix-functions/mbrtoc16.texi
+@include posix-functions/mbrtoc32.texi
@include posix-functions/mbrtowc.texi
@include posix-functions/mbsinit.texi
@include posix-functions/mbsnrtowcs.texi
@include posix-functions/putwchar.texi
@include posix-functions/pwrite.texi
@include posix-functions/qsort.texi
+@include posix-functions/quick_exit.texi
@include posix-functions/raise.texi
@include posix-functions/rand.texi
@include posix-functions/rand_r.texi
@chapter Past POSIX Function Substitutes
This chapter describes which functions and function-like macros specified by
-older versions of POSIX (POSIX:2001) are substituted by Gnulib, which
+older versions of POSIX are substituted by Gnulib, which
portability pitfalls are fixed by Gnulib, and which (known) portability
problems are not worked around by Gnulib.
* fstab.h::
* fts.h::
* getopt.h::
+* gshadow.h::
* ieee754.h::
* ifaddrs.h::
* libintl.h::
@include glibc-headers/fstab.texi
@include glibc-headers/fts.texi
@include glibc-headers/getopt.texi
+@include glibc-headers/gshadow.texi
@include glibc-headers/ieee754.texi
@include glibc-headers/ifaddrs.texi
@include glibc-headers/libintl.texi
* Glibc glob.h::
* Glibc gnu/libc-version.h::
* Glibc grp.h::
+* Glibc gshadow.h::
* Glibc ifaddrs.h::
* Glibc libintl.h::
* Glibc link.h::
* Glibc string.h::
* Glibc sys/capability.h::
* Glibc sys/epoll.h::
+* Glibc sys/fanotify.h::
* Glibc sys/file.h::
* Glibc sys/fsuid.h::
* Glibc sys/gmon.h::
* Glibc sys/ptrace.h::
* Glibc sys/quota.h::
* Glibc sys/reboot.h::
+* Glibc sys/resource.h::
* Glibc sys/sem.h::
* Glibc sys/sendfile.h::
* Glibc sys/socket.h::
* Glibc sys/sysmacros.h::
* Glibc sys/time.h::
* Glibc sys/timex.h::
+* Glibc sys/uio.h::
* Glibc sys/ustat.h::
* Glibc sys/vlimit.h::
* Glibc sys/vm86.h::
@menu
* getdirentries::
+* scandirat::
* versionsort::
@end menu
@include glibc-functions/getdirentries.texi
+@include glibc-functions/scandirat.texi
@include glibc-functions/versionsort.texi
@node Glibc dlfcn.h
@menu
* fallocate::
+* name_to_handle_at::
* readahead::
+* open_by_handle_at::
@end menu
@include glibc-functions/fallocate.texi
+@include glibc-functions/name_to_handle_at.texi
@include glibc-functions/readahead.texi
+@include glibc-functions/open_by_handle_at.texi
@node Glibc fenv.h
@section Glibc Extensions to @code{<fenv.h>}
@include glibc-functions/putgrent.texi
@include glibc-functions/setgroups.texi
+@node Glibc gshadow.h
+@section Glibc @code{<gshadow.h>}
+
+@menu
+* endsgent::
+* fgetsgent::
+* fgetsgent_r::
+* getsgent::
+* getsgent_r::
+* getsgnam::
+* getsgnam_r::
+* putsgent::
+* setsgent::
+* sgetsgent::
+* sgetsgent_r::
+@end menu
+
+@include glibc-functions/endsgent.texi
+@include glibc-functions/fgetsgent.texi
+@include glibc-functions/fgetsgent_r.texi
+@include glibc-functions/getsgent.texi
+@include glibc-functions/getsgent_r.texi
+@include glibc-functions/getsgnam.texi
+@include glibc-functions/getsgnam_r.texi
+@include glibc-functions/putsgent.texi
+@include glibc-functions/setsgent.texi
+@include glibc-functions/sgetsgent.texi
+@include glibc-functions/sgetsgent_r.texi
+
@c @node Glibc iconv.h
@c @section Glibc Extensions to @code{<iconv.h>}
* mallinfo::
* malloc_get_state::
* malloc_set_state::
+* malloc_info::
* malloc_stats::
* malloc_trim::
* malloc_usable_size::
@include glibc-functions/mallinfo.texi
@include glibc-functions/malloc_get_state.texi
@include glibc-functions/malloc_set_state.texi
+@include glibc-functions/malloc_info.texi
@include glibc-functions/malloc_stats.texi
@include glibc-functions/malloc_trim.texi
@include glibc-functions/malloc_usable_size.texi
* inet6_option_init::
* inet6_option_next::
* inet6_option_space::
+* inet6_opt_append::
+* inet6_opt_find::
+* inet6_opt_finish::
+* inet6_opt_get_val::
+* inet6_opt_init::
+* inet6_opt_next::
+* inet6_opt_set_val::
+* inet6_rth_add::
+* inet6_rth_getaddr::
+* inet6_rth_init::
+* inet6_rth_reverse::
+* inet6_rth_segments::
+* inet6_rth_space::
* setipv4sourcefilter::
* setsourcefilter::
@end menu
@include glibc-functions/inet6_option_init.texi
@include glibc-functions/inet6_option_next.texi
@include glibc-functions/inet6_option_space.texi
+@include glibc-functions/inet6_opt_append.texi
+@include glibc-functions/inet6_opt_find.texi
+@include glibc-functions/inet6_opt_finish.texi
+@include glibc-functions/inet6_opt_get_val.texi
+@include glibc-functions/inet6_opt_init.texi
+@include glibc-functions/inet6_opt_next.texi
+@include glibc-functions/inet6_opt_set_val.texi
+@include glibc-functions/inet6_rth_add.texi
+@include glibc-functions/inet6_rth_getaddr.texi
+@include glibc-functions/inet6_rth_init.texi
+@include glibc-functions/inet6_rth_reverse.texi
+@include glibc-functions/inet6_rth_segments.texi
+@include glibc-functions/inet6_rth_space.texi
@include glibc-functions/setipv4sourcefilter.texi
@include glibc-functions/setsourcefilter.texi
* printf_size::
* printf_size_info::
* register_printf_function::
+* register_printf_modifier::
+* register_printf_specifier::
+* register_printf_type::
@end menu
@include glibc-functions/parse_printf_format.texi
@include glibc-functions/printf_size.texi
@include glibc-functions/printf_size_info.texi
@include glibc-functions/register_printf_function.texi
+@include glibc-functions/register_printf_modifier.texi
+@include glibc-functions/register_printf_specifier.texi
+@include glibc-functions/register_printf_type.texi
@node Glibc pthread.h
@section Glibc Extensions to @code{<pthread.h>}
@menu
+* pthread_attr_getaffinity_np::
+* pthread_attr_setaffinity_np::
+* pthread_getaffinity_np::
* pthread_getattr_np::
+* pthread_getname_np::
* pthread_kill_other_threads_np::
+* pthread_mutex_consistent_np::
+* pthread_mutexattr_getrobust_np::
+* pthread_mutexattr_setrobust_np::
* pthread_rwlockattr_getkind_np::
* pthread_rwlockattr_setkind_np::
+* pthread_setaffinity_np::
+* pthread_setname_np::
+* pthread_sigqueue::
+* pthread_timedjoin_np::
+* pthread_tryjoin_np::
* pthread_yield::
@end menu
+@include glibc-functions/pthread_attr_getaffinity_np.texi
+@include glibc-functions/pthread_attr_setaffinity_np.texi
+@include glibc-functions/pthread_getaffinity_np.texi
@include glibc-functions/pthread_getattr_np.texi
+@include glibc-functions/pthread_getname_np.texi
@include glibc-functions/pthread_kill_other_threads_np.texi
+@include glibc-functions/pthread_mutex_consistent_np.texi
+@include glibc-functions/pthread_mutexattr_getrobust_np.texi
+@include glibc-functions/pthread_mutexattr_setrobust_np.texi
@include glibc-functions/pthread_rwlockattr_getkind_np.texi
@include glibc-functions/pthread_rwlockattr_setkind_np.texi
+@include glibc-functions/pthread_setaffinity_np.texi
+@include glibc-functions/pthread_setname_np.texi
+@include glibc-functions/pthread_sigqueue.texi
+@include glibc-functions/pthread_timedjoin_np.texi
+@include glibc-functions/pthread_tryjoin_np.texi
@include glibc-functions/pthread_yield.texi
@node Glibc pty.h
* clone::
* sched_getaffinity::
* sched_setaffinity::
+* setns::
@end menu
@include glibc-functions/clone.texi
@include glibc-functions/sched_getaffinity.texi
@include glibc-functions/sched_setaffinity.texi
+@include glibc-functions/setns.texi
@node Glibc search.h
@section Glibc Extensions to @code{<search.h>}
* qfcvt::
* qfcvt_r::
* qgcvt::
+* qsort_r::
* random_r::
* rpmatch::
+* secure_getenv::
* seed48_r::
* setstate_r::
* srand48_r::
@include glibc-functions/qfcvt.texi
@include glibc-functions/qfcvt_r.texi
@include glibc-functions/qgcvt.texi
+@include glibc-functions/qsort_r.texi
@include glibc-functions/random_r.texi
@include glibc-functions/rpmatch.texi
+@include glibc-functions/secure_getenv.texi
@include glibc-functions/seed48_r.texi
@include glibc-functions/setstate_r.texi
@include glibc-functions/srand48_r.texi
@include glibc-functions/epoll_ctl.texi
@include glibc-functions/epoll_wait.texi
+@node Glibc sys/fanotify.h
+@section Glibc @code{<sys/fanotify.h>}
+
+@menu
+* fanotify_init::
+* fanotify_mark::
+@end menu
+
+@include glibc-functions/fanotify_init.texi
+@include glibc-functions/fanotify_mark.texi
+
@node Glibc sys/file.h
@section Glibc @code{<sys/file.h>}
@include glibc-functions/reboot.texi
-@c @node Glibc sys/resource.h
-@c @section Glibc Extensions to @code{<sys/resource.h>}
+@node Glibc sys/resource.h
+@section Glibc Extensions to @code{<sys/resource.h>}
+
+@menu
+* prlimit::
+@end menu
+
+@include glibc-functions/prlimit.texi
@c @node Glibc sys/select.h
@c @section Glibc Extensions to @code{<sys/select.h>}
@menu
* accept4::
* isfdtype::
+* recvmmsg::
+* sendmmsg::
@end menu
@include glibc-functions/accept4.texi
@include glibc-functions/isfdtype.texi
+@include glibc-functions/recvmmsg.texi
+@include glibc-functions/sendmmsg.texi
@node Glibc sys/stat.h
@section Glibc Extensions to @code{<sys/stat.h>}
* adjtimex::
* ntp_adjtime::
* ntp_gettime::
+* ntp_gettimex::
@end menu
@include glibc-functions/adjtimex.texi
@include glibc-functions/ntp_adjtime.texi
@include glibc-functions/ntp_gettime.texi
+@include glibc-functions/ntp_gettimex.texi
@c @node Glibc sys/types.h
@c @section Glibc Extensions to @code{<sys/types.h>}
-@c @node Glibc sys/uio.h
-@c @section Glibc Extensions to @code{<sys/uio.h>}
+@node Glibc sys/uio.h
+@section Glibc Extensions to @code{<sys/uio.h>}
+
+@menu
+* preadv::
+* process_vm_readv::
+* process_vm_writev::
+* pwritev::
+@end menu
+
+@include glibc-functions/preadv.texi
+@include glibc-functions/process_vm_readv.texi
+@include glibc-functions/process_vm_writev.texi
+@include glibc-functions/pwritev.texi
@c @node Glibc sys/un.h
@c @section Glibc Extensions to @code{<sys/un.h>}
@section Glibc Extensions to @code{<time.h>}
@menu
+* clock_adjtime::
* dysize::
* getdate_r::
* stime::
* strptime_l::
* timegm::
* timelocal::
+* timespec_get::
@end menu
+@include glibc-functions/clock_adjtime.texi
@include glibc-functions/dysize.texi
@include glibc-functions/getdate_r.texi
@include glibc-functions/stime.texi
@include glibc-functions/strptime_l.texi
@include glibc-functions/timegm.texi
@include glibc-functions/timelocal.texi
+@include glibc-functions/timespec_get.texi
@c @node Glibc trace.h
@c @section Glibc Extensions to @code{<trace.h>}
@include glibc-functions/getttynam.texi
@include glibc-functions/setttyent.texi
+@c @node Glibc uchar.h
+@c @section Glibc Extensions to @code{<uchar.h>}
+
@c @node Glibc ucontext.h
@c @section Glibc Extensions to @code{<ucontext.h>}
* setresgid::
* setresuid::
* setusershell::
+* syncfs::
* syscall::
* ttyslot::
* vhangup::
@include glibc-functions/setresgid.texi
@include glibc-functions/setresuid.texi
@include glibc-functions/setusershell.texi
+@include glibc-functions/syncfs.texi
@include glibc-functions/syscall.texi
@include glibc-functions/ttyslot.texi
@include glibc-functions/vhangup.texi
* setutent::
* updwtmp::
* utmpname::
+* login::
* login_tty::
@end menu
@include glibc-functions/setutent.texi
@include glibc-functions/updwtmp.texi
@include glibc-functions/utmpname.texi
+@include glibc-functions/login.texi
@include glibc-functions/login_tty.texi
@node Glibc utmpx.h
* alloca::
* alloca-opt::
* Safe Allocation Macros::
+* Compile-time Assertions::
+* Integer Properties::
+* extern inline::
* String Functions in C Locale::
* Quoting::
* error and progname::
* Visual Studio Compatibility::
* Supporting Relocation::
* func::
+* configmake::
* warnings::
* manywarnings::
* Running self-tests under valgrind::
+* stat-size::
@end menu
@node alloca
@include safe-alloc.texi
+@include verify.texi
+
+@include intprops.texi
+
+@include extern-inline.texi
+
@node String Functions in C Locale
@section Character and String Functions in C Locale
@include func.texi
+@include configmake.texi
+
@include warnings.texi
@include manywarnings.texi
@include valgrind-tests.texi
+@include stat-size.texi
+
+
@node Regular expressions
@chapter Regular expressions
projects / gnulib.git / blobdiff