manual/Makefile

   1 # Copyright (C) 1992-2014 Free Software Foundation, Inc.
   2 # This file is part of the GNU C Library.
   3
   4 # The GNU C Library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8
   9 # The GNU C Library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with the GNU C Library; if not, see
  16 # <http://www.gnu.org/licenses/>.
  17
  18 # Makefile for the GNU C Library manual.
  19
  20 subdir := manual
  21
  22 # Allow override
  23 INSTALL_INFO = install-info
  24
  25 .PHONY: dvi pdf info html
  26
  27 # Get glibc's configuration info.
  28 include ../Makeconfig
  29
  30 dvi: $(objpfx)libc.dvi
  31 pdf: $(objpfx)libc.pdf
  32
  33 TEXI2DVI = texi2dvi
  34 TEXI2PDF = texi2dvi --pdf
  35
  36 ifneq ($(strip $(MAKEINFO)),:)
  37 info: $(objpfx)libc.info
  38 endif
  39
  40 chapters = $(addsuffix .texi, \
  41                        intro errno memory ctype string charset locale   \
  42                        message search pattern io stdio llio filesys     \
  43                        pipe socket terminal syslog math arith time      \
  44                        resource setjmp signal startup process job nss   \
  45                        users sysinfo conf crypt debug threads probes)
  46 add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
  47 appendices = lang.texi header.texi install.texi maint.texi platform.texi \
  48              contrib.texi
  49 licenses = freemanuals.texi lgpl-2.1.texi fdl-1.3.texi
  50
  51 -include $(objpfx)texis
  52 $(objpfx)texis: texis.awk $(chapters) $(add-chapters) $(appendices) $(licenses)
  53         $(make-target-directory)
  54         $(AWK) -f $^ > $@.T
  55         mv -f $@.T $@
  56
  57 nonexamples = $(filter-out $(add-chapters) %.c.texi, $(texis))
  58 examples = $(filter-out $(foreach d, $(add-ons), ../$d/%.c.texi), \
  59                         $(filter %.c.texi, $(texis)))
  60
  61 # Generated files directly included from libc.texinfo.
  62 libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
  63                       libm-err.texi version.texi pkgvers.texi
  64
  65 # Add path to build dir for generated files
  66 texis-path := $(filter-out $(libc-texi-generated) summary.texi $(examples), \
  67                                 $(texis))                                   \
  68          $(addprefix $(objpfx),$(filter $(libc-texi-generated) summary.texi \
  69                                         $(examples), $(texis)))
  70
  71 # Kludge: implicit rule so Make knows the one command does it all.
  72 chapters.% top-menu.%: libc-texinfo.sh $(texis-path) Makefile
  73         AWK=$(AWK) $(SHELL) $< $(objpfx) \
  74                                 '$(chapters)' \
  75                                '$(add-chapters)' \
  76                                '$(appendices) $(licenses)'
  77
  78
  79 $(objpfx)libc.dvi $(objpfx)libc.pdf $(objpfx)libc.info: \
  80         $(addprefix $(objpfx),$(libc-texi-generated))
  81 $(objpfx)libc.dvi $(objpfx)libc.pdf: texinfo.tex
  82
  83 html: $(objpfx)libc/index.html
  84 $(objpfx)libc/index.html: $(addprefix $(objpfx),$(libc-texi-generated))
  85         $(MAKEINFO) -P $(objpfx) -o $(objpfx)libc --html libc.texinfo
  86
  87 # Generate the summary from the Texinfo source files for each chapter.
  88 $(objpfx)summary.texi: $(objpfx)stamp-summary ;
  89 $(objpfx)stamp-summary: summary.awk $(filter-out $(objpfx)summary.texi, \
  90                                         $(texis-path))
  91         -$(SHELL) ./check-safety.sh $(filter-out $(objpfx)%, $(texis-path))
  92         $(AWK) -f $^ | sort -t'\f' -df -k 1,1 | tr '\014' '\012' \
  93                 > $(objpfx)summary-tmp
  94         $(move-if-change) $(objpfx)summary-tmp $(objpfx)summary.texi
  95         touch $@
  96
  97 # Generate a file which can be added to the `dir' content to provide direct
  98 # access to the documentation of the function, variables, and other
  99 # definitions.
 100 $(objpfx)dir-add.texi: xtract-typefun.awk $(texis-path)
 101         (echo "@dircategory GNU C library functions and macros";        \
 102          echo "@direntry";                                              \
 103          $(AWK) -f $^ | sort;                                           \
 104          echo "@end direntry") > $@.new
 105         mv -f $@.new $@
 106
 107 # The table with the math errors is generated.
 108 $(objpfx)libm-err.texi: $(objpfx)stamp-libm-err
 109 $(objpfx)stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
 110                                                      $(dir)/libm-test-ulps))
 111         pwd=`pwd`; \
 112         $(PERL) $< $$pwd/.. > $(objpfx)libm-err-tmp
 113         $(move-if-change) $(objpfx)libm-err-tmp $(objpfx)libm-err.texi
 114         touch $@
 115
 116 # Package version and bug reporting URL.
 117 $(objpfx)pkgvers.texi: $(objpfx)stamp-pkgvers ;
 118 $(objpfx)stamp-pkgvers: $(common-objpfx)config.make
 119         echo "@ifclear PKGVERS" > $(objpfx)pkgvers-tmp
 120         echo "@set PKGVERS" >> $(objpfx)pkgvers-tmp
 121         echo "@set PKGVERSION $(PKGVERSION_TEXI)" >> $(objpfx)pkgvers-tmp
 122         if [ "$(PKGVERSION_TEXI)" = "(GNU libc) " ]; then \
 123           echo "@set PKGVERSION_DEFAULT" >> $(objpfx)pkgvers-tmp; \
 124         fi
 125         echo "@set REPORT_BUGS_TO $(REPORT_BUGS_TEXI)" >> $(objpfx)pkgvers-tmp
 126         echo "@end ifclear" >> $(objpfx)pkgvers-tmp
 127         $(move-if-change) $(objpfx)pkgvers-tmp $(objpfx)pkgvers.texi
 128         touch $@
 129
 130 # Generate a file with the version number.
 131 $(objpfx)version.texi: $(objpfx)stamp-version ;
 132 $(objpfx)stamp-version: $(common-objpfx)config.make
 133         echo "@set VERSION $(version)" > $(objpfx)version-tmp
 134         $(move-if-change) $(objpfx)version-tmp $(objpfx)version.texi
 135         touch $@
 136
 137 # Generate Texinfo files from the C source for the example programs.
 138 $(objpfx)%.c.texi: examples/%.c
 139         sed -e '1,/^\*\/$$/d'                           \
 140             -e 's,[{}],@&,g'                            \
 141             -e 's,/\*\(@.*\)\*/,\1,g'                   \
 142             -e 's,/\*  *,/* @r{,g' -e 's,  *\*/,} */,'  \
 143             -e 's/\(@[a-z][a-z]*\)@{\([^}]*\)@}/\1{\2}/g'\
 144             $< | expand > $@.new
 145         mv -f $@.new $@
 146
 147 $(objpfx)%.info: %.texinfo
 148         LANGUAGE=C LC_ALL=C $(MAKEINFO) -P $(objpfx) --output=$@ $<
 149
 150 $(objpfx)%.dvi: %.texinfo
 151         cd $(objpfx);$(TEXI2DVI) -I $(shell cd $(<D) && pwd) --output=$@ \
 152                                 $(shell cd $(<D) && pwd)/$<
 153
 154 $(objpfx)%.pdf: %.texinfo
 155         cd $(objpfx);$(TEXI2PDF) -I $(shell cd $(<D) && pwd) --output=$@ \
 156                                 $(shell cd $(<D) && pwd)/$<
 157
 158
 159 # Distribution.
 160 minimal-dist = summary.awk texis.awk tsort.awk libc-texinfo.sh libc.texinfo \
 161                libm-err.texi stamp-libm-err check-safety.sh                 \
 162                $(filter-out summary.texi, $(nonexamples))                   \
 163                $(patsubst %.c.texi,examples/%.c, $(examples))
 164
 165 indices = cp fn pg tp vr ky
 166 generated-dirs := libc
 167 generated = libc.dvi libc.pdf libc.tmp libc.info*                           \
 168         stubs                                                               \
 169         texis summary.texi stamp-summary *.c.texi                           \
 170         $(foreach index,$(indices),libc.$(index) libc.$(index)s)            \
 171         libc.log libc.aux libc.toc                                          \
 172         $(libc-texi-generated)                                              \
 173         stamp-libm-err stamp-version
 174
 175 include ../Rules
 176
 177 .PHONY: install subdir_install install-data
 178 install-data subdir_install: install
 179 ifneq ($(strip $(MAKEINFO)),:)
 180 install: $(inst_infodir)/libc.info
 181         @if $(SHELL) -c '$(INSTALL_INFO) --version' >/dev/null 2>&1; then \
 182          test -f $(inst_infodir)/dir || $(INSTALL_DATA) dir $(inst_infodir);\
 183          $(INSTALL_INFO) --info-dir=$(inst_infodir) $(inst_infodir)/libc.info;\
 184         else : ; fi
 185 endif
 186 # Catchall implicit rule for other installation targets from the parent.
 187 install-%: ;
 188
 189 $(inst_infodir)/libc.info: $(objpfx)libc.info
 190         $(make-target-directory)
 191         for file in $<*; do \
 192           $(INSTALL_DATA) $$file $(@D)/; \
 193         done
 194
 195 TAGS: $(minimal-dist)
 196         $(ETAGS) -o $@ $^