]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - manual/Makefile
Consistently include Makeconfig after defining subdir.
[thirdparty/glibc.git] / manual / Makefile
index 0e8ae85dc70b2056745ed73af77f30a38e67bcc9..5c62f9a95db05fbaa2f64634aeecbdc6c919e5be 100644 (file)
-# Copyright (C) 1992, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
+# Copyright (C) 1992-2014 Free Software Foundation, Inc.
 # This file is part of the GNU C Library.
 
 # The GNU C Library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Library General Public License
-# as published by the Free Software Foundation; either version 2 of
-# the License, or (at your option) any later version.
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
 
 # The GNU C Library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# Lesser General Public License for more details.
 
-# You should have received a copy of the GNU Library General Public
-# License along with the GNU C Library; see the file COPYING.LIB.  If not,
-# write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, see
+# <http://www.gnu.org/licenses/>.
 
 # Makefile for the GNU C Library manual.
 
 subdir := manual
-export subdir := $(subdir)
 
-# We need GNU awk for the xtract-typefun script.
-GAWK = gawk
+include ../Makeconfig
 
-.PHONY: all dvi info
-all: dvi info
-dvi: libc.dvi
-info: libc.info
+# Allow override
+INSTALL_INFO = install-info
 
-# Get glibc's configuration info.
-ifneq (,$(wildcard ../Makeconfig))
-include ../Makeconfig
-endif
+.PHONY: dvi pdf info html
+
+dvi: $(objpfx)libc.dvi
+pdf: $(objpfx)libc.pdf
 
-# Set chapters and chapters-incl.
--include chapters
-chapters: libc.texinfo
-       $(find-includes)
-ifdef chapters
--include chapters-incl
-chapters-incl: $(chapters)
-       $(find-includes)
-chapters-incl := $(filter-out summary.texi,$(chapters-incl))
+TEXI2DVI = texi2dvi
+TEXI2PDF = texi2dvi --pdf
+
+ifneq ($(strip $(MAKEINFO)),:)
+info: $(objpfx)libc.info
 endif
 
-define find-includes
-(echo '$(@F) :=' \\    ;\
- awk '$$1 == "@include" { print $$2 " \\" }' $^) > $@.new
-mv -f $@.new $@
-endef
+chapters = $(addsuffix .texi, \
+                      intro errno memory ctype string charset locale   \
+                      message search pattern io stdio llio filesys     \
+                      pipe socket terminal syslog math arith time      \
+                      resource setjmp signal startup process ipc job   \
+                      nss users sysinfo conf crypt debug threads probes)
+add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
+appendices = lang.texi header.texi install.texi maint.texi platform.texi \
+            contrib.texi
+licenses = freemanuals.texi lgpl-2.1.texi fdl-1.3.texi
+
+-include $(objpfx)texis
+$(objpfx)texis: texis.awk $(chapters) $(add-chapters) $(appendices) $(licenses)
+       $(make-target-directory)
+       $(AWK) -f $^ > $@.T
+       mv -f $@.T $@
+
+nonexamples = $(filter-out $(add-chapters) %.c.texi, $(texis))
+examples = $(filter-out $(foreach d, $(add-ons), ../$d/%.c.texi), \
+                       $(filter %.c.texi, $(texis)))
 
-libc.dvi libc.info: $(chapters) summary.texi $(chapters-incl)
-libc.dvi: texinfo.tex
+# Generated files directly included from libc.texinfo.
+libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
+                     libm-err.texi version.texi pkgvers.texi
+
+# Add path to build dir for generated files
+texis-path := $(filter-out $(libc-texi-generated) summary.texi $(examples), \
+                               $(texis))                                   \
+        $(addprefix $(objpfx),$(filter $(libc-texi-generated) summary.texi \
+                                       $(examples), $(texis)))
+
+# Kludge: implicit rule so Make knows the one command does it all.
+chapters.% top-menu.%: libc-texinfo.sh $(texis-path) Makefile
+       AWK=$(AWK) $(SHELL) $< $(objpfx) \
+                               '$(chapters)' \
+                              '$(add-chapters)' \
+                              '$(appendices) $(licenses)'
+
+
+$(objpfx)libc.dvi $(objpfx)libc.pdf $(objpfx)libc.info: \
+       $(addprefix $(objpfx),$(libc-texi-generated))
+$(objpfx)libc.dvi $(objpfx)libc.pdf: texinfo.tex
+
+html: $(objpfx)libc/index.html
+$(objpfx)libc/index.html: $(addprefix $(objpfx),$(libc-texi-generated))
+       $(MAKEINFO) -P $(objpfx) -o $(objpfx)libc --html libc.texinfo
 
 # Generate the summary from the Texinfo source files for each chapter.
-summary.texi: stamp-summary ;
-stamp-summary: summary.awk $(chapters) $(chapters-incl)
-       awk -f $^ \
-       | sort -df +1 -2 | tr '\014' '\012' > summary-tmp
-       ./move-if-change summary-tmp summary.texi
-# touch is broken on our machines.  Sigh.
-       date > $@
+$(objpfx)summary.texi: $(objpfx)stamp-summary ;
+$(objpfx)stamp-summary: summary.awk $(filter-out $(objpfx)summary.texi, \
+                                       $(texis-path))
+       -$(SHELL) ./check-safety.sh $(filter-out $(objpfx)%, $(texis-path))
+       $(AWK) -f $^ | sort -t'\f' -df -k 1,1 | tr '\014' '\012' \
+               > $(objpfx)summary-tmp
+       $(move-if-change) $(objpfx)summary-tmp $(objpfx)summary.texi
+       touch $@
 
 # Generate a file which can be added to the `dir' content to provide direct
 # access to the documentation of the function, variables, and other
 # definitions.
-dir-add.texi: manual/xtract-typefun.awk $(chapters-incl)
-       if test -n "$(chapters-incl)"; then \
-         (for i in $(chapters-incl); do \
-            $(GAWK) -f $< < $i; \
-          done) | sort > $@.new; \
-          ./move-if-change $@.new $@; \
+$(objpfx)dir-add.texi: xtract-typefun.awk $(texis-path)
+       (echo "@dircategory GNU C library functions and macros";        \
+        echo "@direntry";                                              \
+        $(AWK) -f $^ | sort;                                           \
+        echo "@end direntry") > $@.new
+       mv -f $@.new $@
+
+# The table with the math errors is generated.
+$(objpfx)libm-err.texi: $(objpfx)stamp-libm-err
+$(objpfx)stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
+                                                    $(dir)/libm-test-ulps))
+       pwd=`pwd`; \
+       $(PERL) $< $$pwd/.. > $(objpfx)libm-err-tmp
+       $(move-if-change) $(objpfx)libm-err-tmp $(objpfx)libm-err.texi
+       touch $@
+
+# Package version and bug reporting URL.
+$(objpfx)pkgvers.texi: $(objpfx)stamp-pkgvers ;
+$(objpfx)stamp-pkgvers: $(common-objpfx)config.make
+       echo "@ifclear PKGVERS" > $(objpfx)pkgvers-tmp
+       echo "@set PKGVERS" >> $(objpfx)pkgvers-tmp
+       echo "@set PKGVERSION $(PKGVERSION_TEXI)" >> $(objpfx)pkgvers-tmp
+       if [ "$(PKGVERSION_TEXI)" = "(GNU libc) " ]; then \
+         echo "@set PKGVERSION_DEFAULT" >> $(objpfx)pkgvers-tmp; \
        fi
+       echo "@set REPORT_BUGS_TO $(REPORT_BUGS_TEXI)" >> $(objpfx)pkgvers-tmp
+       echo "@end ifclear" >> $(objpfx)pkgvers-tmp
+       $(move-if-change) $(objpfx)pkgvers-tmp $(objpfx)pkgvers.texi
+       touch $@
+
+# Generate a file with the version number.
+$(objpfx)version.texi: $(objpfx)stamp-version ;
+$(objpfx)stamp-version: $(common-objpfx)config.make
+       echo "@set VERSION $(version)" > $(objpfx)version-tmp
+       $(move-if-change) $(objpfx)version-tmp $(objpfx)version.texi
+       touch $@
 
 # Generate Texinfo files from the C source for the example programs.
-%.c.texi: examples/%.c
-       sed -e 's,[{}],@&,g'                            \
+$(objpfx)%.c.texi: examples/%.c
+       sed -e '1,/^\*\/$$/d'                           \
+           -e 's,[{}],@&,g'                            \
            -e 's,/\*\(@.*\)\*/,\1,g'                   \
            -e 's,/\*  *,/* @r{,g' -e 's,  *\*/,} */,'  \
-           -e 's/\(@[a-z][a-z]*\)@{\([^}]*\)@}/\1{\2}/'\
+           -e 's/\(@[a-z][a-z]*\)@{\([^}]*\)@}/\1{\2}/g'\
            $< | expand > $@.new
        mv -f $@.new $@
 
+$(objpfx)%.info: %.texinfo
+       LANGUAGE=C LC_ALL=C $(MAKEINFO) -P $(objpfx) --output=$@ $<
 
-minimal-dist = summary.awk move-if-change libc.texinfo $(chapters)     \
-              $(patsubst %.c.texi,examples/%.c,                        \
-                         $(filter-out summary.texi,$(chapters-incl)))
-doc-only-dist = Makefile COPYING.LIB mkinstalldirs
-distribute = $(minimal-dist)                                           \
-            $(patsubst examples/%.c,%.c.texi,$(filter examples/%.c,    \
-                       $(minimal-dist)))                               \
-            libc.info* libc.?? libc.??s texinfo.tex summary.texi       \
-            stamp-summary chapters chapters-incl                       \
-            xtract-typefun.awk
-export distribute := $(distribute)
+$(objpfx)%.dvi: %.texinfo
+       cd $(objpfx);$(TEXI2DVI) -I $(shell cd $(<D) && pwd) --output=$@ \
+                               $(shell cd $(<D) && pwd)/$<
 
-tar-it = tar chovf $@ $^
+$(objpfx)%.pdf: %.texinfo
+       cd $(objpfx);$(TEXI2PDF) -I $(shell cd $(<D) && pwd) --output=$@ \
+                               $(shell cd $(<D) && pwd)/$<
 
-manual.tar: $(doc-only-dist) $(minimal-dist) ; $(tar-it)
-mandist.tar: $(doc-only-dist) $(distribute) ; $(tar-it)
 
-edition := $(shell sed -n 's/^@set EDITION \([0-9][0-9.]*\)[^0-9.]*.*$$/\1/p' \
-                      libc.texinfo)
+# Distribution.
+minimal-dist = summary.awk texis.awk tsort.awk libc-texinfo.sh libc.texinfo \
+              libm-err.texi stamp-libm-err check-safety.sh                 \
+              $(filter-out summary.texi, $(nonexamples))                   \
+              $(patsubst %.c.texi,examples/%.c, $(examples))
 
-glibc-doc-$(edition).tar: $(doc-only-dist) $(distribute)
-       @rm -f glibc-doc-$(edition)
-       ln -s . glibc-doc-$(edition)
-       tar chovf $@ $(addprefix glibc-doc-$(edition)/,$^)
-       rm -f glibc-doc-$(edition)
-
-%.Z: %
-       compress -c $< > $@.new
-       mv -f $@.new $@
-%.gz: %
-       gzip -9 -c $< > $@.new
-       mv -f $@.new $@
-%.uu: %
-       uuencode $< < $< > $@.new
-       mv -f $@.new $@
-
-.PHONY: mostlyclean distclean realclean clean
-mostlyclean:
-       -rm -f libc.dvi libc.info*
-clean: mostlyclean
-distclean: clean
 indices = cp fn pg tp vr ky
-realclean: distclean
-       -rm -f chapters chapters-incl summary.texi stamp-summary *.c.texi
-       -rm -f $(foreach index,$(indices),libc.$(index) libc.$(index)s)
-       -rm -f libc.log libc.aux libc.toc
-
-.PHONY: install subdir_install installdirs install-data
+generated-dirs := libc
+generated = libc.dvi libc.pdf libc.tmp libc.info*                          \
+       stubs                                                               \
+       texis summary.texi stamp-summary *.c.texi                           \
+       $(foreach index,$(indices),libc.$(index) libc.$(index)s)            \
+       libc.log libc.aux libc.toc                                          \
+       $(libc-texi-generated)                                              \
+       stamp-libm-err stamp-version
+
+include ../Rules
+
+.PHONY: install subdir_install install-data
 install-data subdir_install: install
+ifneq ($(strip $(MAKEINFO)),:)
 install: $(inst_infodir)/libc.info
+       @if $(SHELL) -c '$(INSTALL_INFO) --version' >/dev/null 2>&1; then \
+        test -f $(inst_infodir)/dir || $(INSTALL_DATA) dir $(inst_infodir);\
+        $(INSTALL_INFO) --info-dir=$(inst_infodir) $(inst_infodir)/libc.info;\
+       else : ; fi
+endif
 # Catchall implicit rule for other installation targets from the parent.
 install-%: ;
 
-$(inst_infodir)/libc.info: libc.info installdirs
+$(inst_infodir)/libc.info: $(objpfx)libc.info
+       $(make-target-directory)
        for file in $<*; do \
-         name=`basename $$file`; \
-         $(INSTALL_DATA) $$file \
-           `echo $@ | sed "s,$<\$$,$$name,"`; \
+         $(INSTALL_DATA) $$file $(@D)/; \
        done
 
-installdirs: $(firstword $(wildcard mkinstalldirs ../mkinstalldirs))
-       $(dir $<)$(notdir $<) $(inst_infodir)
-
-.PHONY: dist
-dist: # glibc-doc-$(edition).tar.gz
-
-ifneq (,$(wildcard ../Make-dist))
-dist: ../Make-dist
-       $(MAKE) -f $< $(Make-dist-args)
-endif
-
-ifndef ETAGS
-ETAGS = etags -T
-endif
 TAGS: $(minimal-dist)
        $(ETAGS) -o $@ $^
-\f
-# The parent makefile sometimes invokes us with targets `subdir_REAL-TARGET'.
-subdir_%: % ;
-# For targets we don't define, do nothing.
-subdir_%: ;
-
-# These are targets that each glibc subdirectory is expected to understand.
-# ../Rules defines them for code subdirectories; for us, they are no-ops.
-# None of these should be `subdir_TARGET'; those targets are transformed
-# by the implicit rule above into `TARGET' deps.
-glibc-targets  := lib objects objs others tests lint.out \
-                  echo-headers echo-distinfo stubs
-.PHONY: $(glibc-targets)
-$(glibc-targets):
-
-# Create stamp files if they don't exist, so the parent makefile's rules for
-# updating the library archives are happy with us, and never think we have
-# changed the library.
-lib: $(foreach o,$(object-suffixes),$(objpfx)stamp$o-$(subdir))
-stubs: $(common-objpfx)stub-manual
-$(common-objpfx)stub-manual ../po/manual.pot $(objpfx)stamp%-$(subdir):
-       $(make-target-directory)
-       cp /dev/null $@
-
-
-# Make the target directory if it doesn't exist, using the `mkinstalldirs'
-# script that does `mkdir -p' even if `mkdir' doesn't support that flag.
-define make-target-directory
-$(addprefix $(..)./mkinstalldirs ,\
-           $(filter-out $(wildcard $(@D:%/=%)),$(@D:%/=%)))
-endef
-
-# The top-level glibc Makefile expects subdir_install to update the stubs file.
-subdir_install: stubs
-\f
-# Get rid of these variables if they came from the parent.
-routines =
-aux =
-sources =
-objects =
-headers =