aboutsummaryrefslogtreecommitdiff
path: root/manual/Makefile
AgeCommit message (Collapse)AuthorFilesLines
2017-06-15manual: Replace summary.awk with summary.pl.Rical Jasan1-5/+4
The Summary is now generated from @standards, and syntax-checking is performed. If invalid @standards syntax is detected, summary.pl will fail, reporting all errors. Failure and error reporting is disabled for now, however, since much of the manual is still incomplete wrt. header and standards annotations. Note that the sorting order of the Summary has changed; summary.pl respects the locale, like summary.awk did, but the use of LC_ALL=C is introduced in the Makefile. Other notable deviations are improved detection of the annotated elements' names, which are used for sorting, and improved detection of the @node used to reference into the manual. The most noticeable difference in the rendered Summary is that entries may now contain multiple lines, one for each header and standard combination. summary.pl accepts a `--help' option, which details the expected syntax of @standards. If errors are reported, the user is directed to this feature for further information. * manual/Makefile: Generate summary.texi with summary.pl. Force use of the C locale. Update Perl dependency comment. * manual/header.texi: Update reference to summary.awk. * manual/macros.texi: Refer authors to `summary.pl --help'. * manual/summary.awk: Remove file. * manual/summary.pl: New file. Generate summary.texi, and check for @standards-related syntax errors. * manual/argp.texi: Convert header and standards @comments to @standards. * manual/arith.texi: Likewise. * manual/charset.texi: Likewise. * manual/conf.texi: Likewise. * manual/creature.texi: Likewise. * manual/crypt.texi: Likewise. * manual/ctype.texi: Likewise. * manual/debug.texi: Likewise. * manual/errno.texi: Likewise. * manual/filesys.texi: Likewise. * manual/getopt.texi: Likewise. * manual/job.texi: Likewise. * manual/lang.texi: Likewise. * manual/llio.texi: Likewise. * manual/locale.texi: Likewise. * manual/math.texi: Likewise. * manual/memory.texi: Likewise. * manual/message.texi: Likewise. * manual/pattern.texi: Likewise. * manual/pipe.texi: Likewise. * manual/process.texi: Likewise. * manual/resource.texi: Likewise. * manual/search.texi: Likewise. * manual/setjmp.texi: Likewise. * manual/signal.texi: Likewise. * manual/socket.texi: Likewise. * manual/startup.texi: Likewise. * manual/stdio.texi: Likewise. * manual/string.texi: Likewise. * manual/sysinfo.texi: Likewise. * manual/syslog.texi: Likewise. * manual/terminal.texi: Likewise. * manual/threads.texi: Likewise. * manual/time.texi: Likewise. * manual/users.texi: Likewise.
2017-01-01Update copyright dates with scripts/update-copyrights.Joseph Myers1-1/+1
2016-12-31User manual documentation for tunablesSiddhesh Poyarekar1-1/+2
Create a new node for tunables documentation and add notes for the malloc tunables. * manual/tunables.texi: New chapter. * manual/Makefile (chapters): Add it. * manual/probes.texi (@node): Point to the Tunables chapter.
2016-01-04Update copyright dates with scripts/update-copyrights.Joseph Myers1-1/+1
2015-08-21manual: skip build when perl is unavailableMike Frysinger1-0/+3
Do not try to generate the manual when perl is unavailable. This matches the behavior when makeinfo is unavailable. Otherwise the install step fails when trying to generate the libm section since it runs a perl script.
2015-01-02Update copyright dates with scripts/update-copyrights.Joseph Myers1-1/+1
2014-11-21Require check-safety.sh to pass; wish for check that all fns are documentedAlexandre Oliva1-1/+1
for ChangeLog * manual/Makefile ($(objpfx)stamp-summary): Require check-safety.sh to pass. * manual/check-safety.sh: Wish for verification that every @deftypefn and @deftypefun is followed by a @safety remark.
2014-03-06Remove INSTALL_INFO setting in manual/Makefile.Joseph Myers1-3/+0
* manual/Makefile (INSTALL_INFO): Remove variable setting.
2014-02-28Fix fallout from Joseph's untested Makeconfig change.Roland McGrath1-8/+8
2014-02-26Consistently include Makeconfig after defining subdir.Joseph Myers1-3/+2
In <https://sourceware.org/ml/libc-alpha/2014-01/msg00196.html> I noted it was necessary to add includes of Makeconfig early in various subdirectory makefiles for the tests-special variable settings added by that patch to be conditional on configuration information. No-one commented on the general question there of whether Makeconfig should always be included immediately after the definition of subdir. This patch implements that early inclusion of Makeconfig in each directory (which is a lot easier than consistent placement of includes of Rules). Includes are added if needed, or moved up if already present. Subdirectory "all:" targets are removed, since Makeconfig provides one. There is potential for further cleanups I haven't done. Rules and Makerules have code such as ifneq "$(findstring env,$(origin headers))" "" headers := endif to override to empty any value of various variables that came from the environment. I think there is a case for Makeconfig setting all the subdirectory variables (other than subdir) to empty to ensure no outside value is going to take effect if a subdirectory fails to define a variable. (A list of such variables, possibly out of date and incomplete, is in manual/maint.texi.) Rules and Makerules would give errors if Makeconfig hadn't already been included, instead of including it themselves. The special code to override values coming from the environment would then be obsolete and could be removed. Tested x86_64, including that installed binaries are identical before and after the patch. * argp/Makefile: Include Makeconfig immediately after defining subdir. * assert/Makefile: Likewise. * benchtests/Makefile: Likewise. * catgets/Makefile: Likewise. * conform/Makefile: Likewise. * crypt/Makefile: Likewise. * csu/Makefile: Likewise. (all): Remove target. * ctype/Makefile: Include Makeconfig immediately after defining subdir. * debug/Makefile: Likewise. * dirent/Makefile: Likewise. * dlfcn/Makefile: Likewise. * gmon/Makefile: Likewise. * gnulib/Makefile: Likewise. * grp/Makefile: Likewise. * gshadow/Makefile: Likewise. * hesiod/Makefile: Likewise. * hurd/Makefile: Likewise. (all): Remove target. * iconvdata/Makefile: Include Makeconfig immediately after defining subdir. * inet/Makefile: Likewise. * intl/Makefile: Likewise. * io/Makefile: Likewise. * libio/Makefile: Likewise. (all): Remove target. * locale/Makefile: Include Makeconfig immediately after defining subdir. * login/Makefile: Likewise. * mach/Makefile: Likewise. (all): Remove target. * malloc/Makefile: Include Makeconfig immediately after defining subdir. (all): Remove target. * manual/Makefile: Include Makeconfig immediately after defining subdir. * math/Makefile: Likewise. * misc/Makefile: Likewise. * nis/Makefile: Likewise. * nss/Makefile: Likewise. * po/Makefile: Likewise. (all): Remove target. * posix/Makefile: Include Makeconfig immediately after defining subdir. * pwd/Makefile: Likewise. * resolv/Makefile: Likewise. * resource/Makefile: Likewise. * rt/Makefile: Likewise. * setjmp/Makefile: Likewise. * shadow/Makefile: Likewise. * signal/Makefile: Likewise. * socket/Makefile: Likewise. * soft-fp/Makefile: Likewise. * stdio-common/Makefile: Likewise. * stdlib/Makefile: Likewise. * streams/Makefile: Likewise. * string/Makefile: Likewise. * sunrpc/Makefile: Likewise. (all): Remove target. * sysvipc/Makefile: Include Makeconfig immediately after defining subdir. * termios/Makefile: Likewise. * time/Makefile: Likewise. * timezone/Makefile: Likewise. (all): Remove target. * wcsmbs/Makefile: Include Makeconfig immediately after defining subdir. * wctype/Makefile: Likewise. libidn/ChangeLog: * Makefile: Include Makeconfig immediately after defining subdir. localedata/ChangeLog: * Makefile: Include Makeconfig immediately after defining subdir. (all): Remove target. nptl/ChangeLog: * Makefile: Include Makeconfig immediately after defining subdir. nptl_db/ChangeLog: * Makefile: Include Makeconfig immediately after defining subdir.
2014-02-26Add a new "Inter-Process Communication" chapter.Carlos O'Donell1-2/+2
This patch adds a new "Inter-Process Communication" chapter to cover the sem*, msg*, and shm* functions. Initially we document only the sem* function signatures and their safety notes.
2014-02-01* manual/check-safety.sh: New.Alexandre Oliva1-1/+2
* manual/Makefile ($(objpfx)stamp-summary): Run it.
2014-01-01Update copyright notices with scripts/update-copyrightsAllan McRae1-1/+1
2013-09-20Add first set of memory probes.Alexandre Oliva1-1/+1
for ChangeLog * malloc/malloc.c: Include stap-probe.h. (__libc_mallopt): Add memory_mallopt probe. * malloc/arena.c (_int_new_arena): Add memory_arena_new probe. * manual/probes.texi: New. * manual/Makefile (chapters): Add probes. * manual/threads.texi: Set next node.
2013-03-19Rename nptl.texi to threads.texiSiddhesh Poyarekar1-1/+1
The manual and its file names are about interfaces and not the implementation details.
2013-03-14Add nptl manual chapterSiddhesh Poyarekar1-1/+1
This adds the base chapter for POSIX threads and also documentation for thread-specific data, along with a note on its interaction with C++11 thread_local variables.
2013-01-02Update copyright notices with scripts/update-copyrights.Joseph Myers1-1/+1
2013-01-01Add script to update copyright notices and reformat some to facilitate its use.Joseph Myers1-2/+1
2012-11-09Support --with-pkgversion and --with-bugurl.Joseph Myers1-1/+15
2012-06-14Make sure <build-dir>/manual directory gets created.Roland McGrath1-0/+1
2012-06-04Manual for platform-specific features and new __ppc_get_timebase inline.Tulio Magno Quites Machado Filho1-1/+2
[BZ #13743] A new class of installed headers has been documented for low-level platform-specific functionality. PowerPC added the first instance with a function to provide time base register access (__ppc_get_timebase). This is required for applications that measure time at high frequencies with high precision that can't afford a syscall.
2012-05-14Do not build manual in source dirAndreas Jaeger1-105/+66
[BZ #13750] Do not build manual anymore in the source dir. Also clean up the Makefile and remove rules that have been used previously when we had a stand-alone Makefile which was obsoleted recently.
2012-05-04Revert "Do not build manual in the source directory"Andreas Jaeger1-62/+49
This reverts commit e3945c47bdac1149a1fec5d46bd567a248cd17b9. reverting since it breaks building.
2012-05-04Do not build manual in the source directoryAndreas Jaeger1-49/+62
[BZ #13750] Build the manual in the build directory and not anymore in the source directory.
2012-04-23Remove standalone manual supportAndreas Jaeger1-42/+1
[BZ #13739] We don't need a separate manual distribution tar ball anymore, remove support for it from manual/Makefile.
2012-03-07Remove distribute variable from MakefilesUlrich Drepper1-9/+0
2012-03-02BZ #13792: License manual example source files under GPL.Roland McGrath1-1/+2
2012-02-27Automatically generate version number in manual; omit edition / updated date.Joseph Myers1-6/+16
2012-02-24Update makefile for FDL 1.3 change.Joseph Myers1-2/+2
2012-02-09Replace FSF snail mail address with URLs.Paul Eggert1-3/+2
2011-06-06Use canonical FSF .texi files for LGPL and FDL texts.Roland McGrath1-5/+7
2010-09-06Don't mix pattern rules with normal rulesAndreas Schwab1-1/+4
2006-01-082006-01-07 Roland McGrath <roland@redhat.com>Roland McGrath1-4/+3
* Makerules (common-clean): Don't remove distinfo file. ($(objpfx)distinfo): Target removed. * manual/Makefile (mostlyclean): Don't remove distinfo file. (glibc-targets): Remove echo-distinfo.
2005-07-182005-07-13 Thorsten Kukuk <kukuk@suse.de>Roland McGrath1-1/+1
* manual/Makefile (libc/index.html): Add dir-add.texi.
2004-12-22(CFLAGS-tst-align.c): Add -mpreferred-stack-boundary=4.Ulrich Drepper1-4/+5
2007-07-122.5-18.1Jakub Jelinek1-5/+4
2004-03-18* manual/Makefile (stamp-summary): Use -k option to sort,Roland McGrath1-2/+3
not traditional key selection syntax. Reported by Jim Gifford <giffordj@linkline.com>.
2003-11-122003-11-11 Roland McGrath <roland@redhat.com>Roland McGrath1-27/+12
* manual/Makefile (info): Don't depend on dir-add.info. (libc.dvi libc.pdf libc.info): Depend on dir-add.texi. (dir-add.info): Target removed, replaced with ... (dir-add.texi): New target. (distribute): Add it. (install): Remove variant with --section arguments. Let the @dircategory directives do their work. (mostlyclean): Don't remove dir-add.info here. (realclean): Remove dir-add.texi here. * manual/libc.texinfo: @include dir-add.texi * configure.in: Remove check for old Debian install-info. * configure: Regenerated. * config.make.in (OLD_DEBIAN_INSTALL_INFO): Variable removed.
2002-04-21(glibc-targets): Add xtests.Ulrich Drepper1-2/+2
2001-08-28* manual/libc-texinfo.sh: Add entry about free manuals.Andreas Jaeger1-1/+2
* manual/contrib.texi (Contributors): Fix cross reference. * manual/libc.texinfo (Copying): Include freemanuals. * manual/Makefile (appendices): Add freemanuals. * manual/freemanuals.texi: New file. Patch by Brian Youmans <3diff@gnu.org>. * manual/libm-err-tab.pl: Pretty print more platforms, print a smaller table. * manual/math.texi (Errors in Math Functions): Fix grammar, start table on separate page. Patch by Brian Youmans <3diff@gnu.org>.
2001-07-19Update.Ulrich Drepper1-1/+5
2001-07-19 Ulrich Drepper <drepper@redhat.com> * Makefile: Add html goal. * manual/Makefile: Likewise.
2001-07-06Update.Andreas Jaeger1-1/+1
2001-07-06 Andreas Jaeger <aj@suse.de> * manual/Makefile (texis): Add fdl.texi. * manual/fdl.texi: New. * manual/socket.texi (Host Names): Improve grammar, fix overflow hbox. * manual/libc.texinfo: Add fdl, update titlepage. Patches by Brian Youmans <3diff@gnu.org>. * sysdeps/unix/make_errlist.c (main): Print LGPL v2.1 for generated file.
2001-07-06 * COPYING: Fix Y2k bug in sample copyright notices.Andreas Jaeger1-1/+1
* manual/lesser.texi: Renamed from manual/lgpl.texinfo, as fsf.org uses the name "lesser.texi". * manual/Makefile (texis): Follow rename.
2001-07-06Update to LGPL v2.1.Andreas Jaeger1-8/+8
2001-07-06 Paul Eggert <eggert@twinsun.com> * manual/argp.texi: Remove ignored LGPL copyright notice; it's not appropriate for documentation anyway. * manual/libc-texinfo.sh: "Library General Public License" -> "Lesser General Public License". 2001-07-06 Andreas Jaeger <aj@suse.de> * All files under GPL/LGPL version 2: Place under LGPL version 2.1.
2001-03-19Update.Ulrich Drepper1-2/+2
2001-03-17 H.J. Lu <hjl@gnu.org> * manual/Makefile (install): Use $(INSTALL_DATA) instead of cp to install `dir'.
2001-01-17Update.Ulrich Drepper1-1/+1
2001-01-17 Ulrich Drepper <drepper@redhat.com> * manual/Makefile (chapters): Add debug. * manual/debug.texi: New file. * manual/examples/execinfo.c: New file. Patch by suckfish@ihug.co.nz.
2001-01-03Update.Ulrich Drepper1-2/+2
* manual/Makefile (TEXI2PDF): Change to texi2dvi --pdf. Suggested by Minko Markov <mmarkov@home.com>. 2001-01-02 Franz Sirl <Franz.Sirl-kernel@lauterbach.com> * sysdeps/powerpc/elf/start.S (__data_start): Make it global. * sysdeps/powerpc/dl-machine.c (dl_reloc_overflow): Print the name of the failing symbol. (__process_machine_rela): Pass symbol to dl_reloc_overflow(). 2001-01-02 Ben Collins <bcollins@debian.org> * time/tzset.c (tzset_internal): Make sure we fall back to UTC if TZ is not set and TZDEFAULT is not present. 2001-01-01 Ben Collins <bcollins@debian.org> * string/strings.h: Make sure we declare our functions even if string.h is already included, based on whether or not __USE_BSD is defined. 2001-01-02 Ulrich Drepper <drepper@redhat.com> * dlfcn/dlerror.c (dlerror): Handle call of dlerror() before any other dlopen() and dlsym(). Based on a patch by Ben Collins <bcollins@debian.org>. 2001-01-02 Andreas Jaeger <aj@suse.de> * dlfcn/errmsg1.c (main): Call dlerror initially. Reported by Ben Collins <bcollins@debian.org>. 2001-01-02 Ulrich Drepper <drepper@redhat.com>
2000-04-24Update.Ulrich Drepper1-3/+3
* manual/Makefile (chapters): Add syslog. * manual/syslog.texi: New file. * manual/math.texi: Fix references. * manual/terminal.texi: Likewise. Patch by Bryan Henderson <bryanh@giraffe-data.com>. 2000-04-18 Jakub Jelinek <jakub@redhat.com> * posix/sys/wait.h: Define __WAIT_STATUS and the like either if stdlib.h was not included or __USE_XOPEN not defined. 2000-04-23 Ulrich Drepper <drepper@redhat.com>
2000-04-18Update.Ulrich Drepper1-4/+4
* manual/Makefile (chapters): Add resource. * manual/time.texi: Move section on resources to... * manual/resource.texi: ...here. New file. * manual/setjmp.texi: Adjust back reference. Patch by Bryan Henderson <bryanh@giraffe-data.com>.
2000-03-17Update.Ulrich Drepper1-2/+2
2000-03-16 Andreas Jaeger <aj@suse.de> * manual/Makefile: MAKEINFO is set to `:' from configure if it doesn't exist, correct checks. Fixes PR libc/1649.