manual/Makefile

   1 # Copyright (C) 1992, 93, 94, 95, 96, 97, 98 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 Library General Public License
   6 # as published by the Free Software Foundation; either version 2 of
   7 # 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 # Library General Public License for more details.
  13
  14 # You should have received a copy of the GNU Library General Public
  15 # License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16 # write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17 # Boston, MA 02111-1307, USA.
  18
  19 # Makefile for the GNU C Library manual.
  20
  21 subdir := manual
  22 export subdir := $(subdir)
  23
  24 # Allow override
  25 INSTALL_INFO = install-info
  26
  27 .PHONY: all dvi info
  28 all: dvi
  29 dvi: libc.dvi
  30
  31 # Get glibc's configuration info.
  32 ifneq (,$(wildcard ../Makeconfig))
  33 include ../Makeconfig
  34 else
  35 MAKEINFO = makeinfo
  36 TEXI2DVI = texi2dvi
  37 AWK = gawk
  38 endif
  39
  40 ifneq ($(strip $(MAKEINFO)),)
  41 all: info
  42 info: libc.info dir-add.info
  43 endif
  44
  45 # scripts we use
  46 ifndef move-if-change
  47 move-if-change = ./move-if-change
  48 endif
  49 mkinstalldirs = $(..)scripts/mkinstalldirs
  50
  51 chapters = $(addsuffix .texi, \
  52                        intro errno memory ctype string mbyte locale     \
  53                        message search pattern io stdio llio filesys     \
  54                        pipe socket terminal math arith time setjmp      \
  55                        signal startup process job nss users sysinfo conf)
  56 add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
  57 appendices = lang.texi header.texi install.texi maint.texi contrib.texi
  58
  59 -include texis
  60 texis: texis.awk $(chapters) $(add-chapters) $(appendices) lgpl.texinfo
  61         $(AWK) -f $^ > $@.T
  62         mv -f $@.T $@
  63
  64 nonexamples = $(filter-out $(add-chapters) %.c.texi, $(texis))
  65 examples = $(filter %.c.texi, $(texis))
  66
  67 # Kludge: implicit rule so Make knows the one command does it all.
  68 chapters.% top-menu.%: libc-texinfo.sh $(texis)
  69         AWK=$(AWK) $(SHELL) $< '$(chapters)' '$(add-chapters)' '$(appendices)'
  70
  71 libc.dvi libc.info: chapters.texi top-menu.texi
  72 libc.dvi: texinfo.tex
  73
  74 # Generate the summary from the Texinfo source files for each chapter.
  75 summary.texi: stamp-summary ;
  76 stamp-summary: summary.awk $(filter-out summary.texi, $(texis))
  77         $(AWK) -f $^ | sort -df +1 -2 | tr '\014' '\012' > summary-tmp
  78         $(move-if-change) summary-tmp summary.texi
  79         touch $@
  80
  81 # Generate a file which can be added to the `dir' content to provide direct
  82 # access to the documentation of the function, variables, and other
  83 # definitions.
  84 dir-add.texinfo: xtract-typefun.awk $(texis)
  85         (echo "@dircategory GNU C library functions";                   \
  86          echo "@direntry";                                              \
  87          $(AWK) -f $^;                                                  \
  88          echo "@end direntry") > $@.new
  89         mv -f $@.new $@
  90
  91 # Generate Texinfo files from the C source for the example programs.
  92 %.c.texi: examples/%.c
  93         sed -e 's,[{}],@&,g'                            \
  94             -e 's,/\*\(@.*\)\*/,\1,g'                   \
  95             -e 's,/\*  *,/* @r{,g' -e 's,  *\*/,} */,'  \
  96             -e 's/\(@[a-z][a-z]*\)@{\([^}]*\)@}/\1{\2}/g'\
  97             $< | expand > $@.new
  98         mv -f $@.new $@
  99
 100 %.info: %.texinfo
 101         $(MAKEINFO) $<
 102
 103 %.dvi: %.texinfo
 104         $(TEXI2DVI) $<
 105
 106 # Distribution.
 107 minimal-dist = summary.awk texis.awk libc-texinfo.sh libc.texinfo       \
 108                $(filter-out summary.texi, $(nonexamples))               \
 109                $(patsubst %.c.texi,examples/%.c, $(examples))
 110
 111 doc-only-dist = Makefile COPYING.LIB
 112 distribute = $(minimal-dist) $(examples) texis stdio-fp.c               \
 113              libc.info* libc.?? libc.??s texinfo.tex stamp-summary      \
 114              xtract-typefun.awk dir-add.texinfo dir-add.info dir        \
 115              chapters.texi top-menu.texi summary.texi
 116 export distribute := $(distribute)
 117
 118 tar-it = tar chovf $@ $^
 119
 120 manual.tar: $(doc-only-dist) $(minimal-dist) ; $(tar-it)
 121 mandist.tar: $(doc-only-dist) $(distribute) ; $(tar-it)
 122
 123 edition := $(shell sed -n 's/^@set EDITION \([0-9][0-9.]*\)[^0-9.]*.*$$/\1/p' \
 124                        libc.texinfo)
 125
 126 glibc-doc-$(edition).tar: $(doc-only-dist) $(distribute)
 127         @rm -f glibc-doc-$(edition)
 128         ln -s . glibc-doc-$(edition)
 129         tar chovf $@ $(addprefix glibc-doc-$(edition)/,$^)
 130         rm -f glibc-doc-$(edition)
 131
 132 %.Z: %
 133         compress -c $< > $@.new
 134         mv -f $@.new $@
 135 %.gz: %
 136         gzip -9 -c $< > $@.new
 137         mv -f $@.new $@
 138 %.uu: %
 139         uuencode $< < $< > $@.new
 140         mv -f $@.new $@
 141
 142 .PHONY: mostlyclean distclean realclean clean
 143 mostlyclean:
 144         -rm -f libc.dvi libc.tmp libc.info* dir-add.info
 145         -rm -f $(objpfx)stubs $(objpfx)distinfo
 146         -rm -f $(foreach o,$(object-suffixes-for-libc),$(objpfx)stamp$o)
 147 clean: mostlyclean
 148 distclean: clean
 149 indices = cp fn pg tp vr ky
 150 realclean: distclean
 151         -rm -f texis summary.texi stamp-summary *.c.texi
 152         -rm -f $(foreach index,$(indices),libc.$(index) libc.$(index)s)
 153         -rm -f libc.log libc.aux libc.toc dir-add.texinfo
 154         -rm -f top-menu.texi chapters.texi
 155
 156 .PHONY: install subdir_install installdirs install-data
 157 install-data subdir_install: install
 158 ifneq ($(strip $(MAKEINFO)),)
 159 install: $(inst_infodir)/libc.info dir-add.info
 160         @if $(SHELL) -c '$(INSTALL_INFO) --version' >/dev/null 2>&1; then \
 161           test -f $(inst_infodir)/dir || cp dir $(inst_infodir);\
 162          $(INSTALL_INFO) --info-dir=$(inst_infodir) $(inst_infodir)/libc.info;\
 163          $(INSTALL_INFO) --info-dir=$(inst_infodir) dir-add.info;\
 164         else : ; fi
 165 endif
 166 # Catchall implicit rule for other installation targets from the parent.
 167 install-%: ;
 168
 169 $(inst_infodir)/libc.info: libc.info installdirs
 170         for file in $<*; do \
 171           $(INSTALL_DATA) $$file $(@D)/$$file; \
 172         done
 173
 174 installdirs:
 175         $(mkinstalldirs) $(inst_infodir)
 176
 177 .PHONY: dist
 178 dist: # glibc-doc-$(edition).tar.gz
 179
 180 ifneq (,$(wildcard ../Make-dist))
 181 dist: ../Make-dist
 182         $(MAKE) -f $< $(Make-dist-args)
 183 endif
 184
 185 ifndef ETAGS
 186 ETAGS = etags -T
 187 endif
 188 TAGS: $(minimal-dist)
 189         $(ETAGS) -o $@ $^
 190 \f
 191 # The parent makefile sometimes invokes us with targets `subdir_REAL-TARGET'.
 192 subdir_%: % ;
 193 # For targets we don't define, do nothing.
 194 subdir_%: ;
 195
 196 # These are targets that each glibc subdirectory is expected to understand.
 197 # ../Rules defines them for code subdirectories; for us, they are no-ops.
 198 # None of these should be `subdir_TARGET'; those targets are transformed
 199 # by the implicit rule above into `TARGET' deps.
 200 glibc-targets   := lib objects objs others tests lint.out \
 201                    echo-headers echo-distinfo
 202 .PHONY: $(glibc-targets)
 203 $(glibc-targets):
 204
 205 # Create stamp files if they don't exist, so the parent makefile's rules for
 206 # updating the library archives are happy with us, and never think we have
 207 # changed the library.
 208 lib: $(foreach o,$(object-suffixes-for-libc),$(objpfx)stamp$o)
 209 ifdef objpfx
 210 .PHONY: stubs
 211 stubs: $(objpfx)stubs
 212 endif
 213 $(objpfx)stubs ../po/manual.pot $(objpfx)stamp%:
 214         $(make-target-directory)
 215         touch $@
 216
 217 # Make the target directory if it doesn't exist, using the `mkinstalldirs'
 218 # script that does `mkdir -p' even if `mkdir' doesn't support that flag.
 219 define make-target-directory
 220 $(addprefix $(mkinstalldirs) ,\
 221             $(filter-out $(wildcard $(@D:%/=%)),$(@D:%/=%)))
 222 endef
 223
 224 # The top-level glibc Makefile expects subdir_install to update the stubs file.
 225 subdir_install: stubs
 226 \f
 227 # Get rid of these variables if they came from the parent.
 228 routines =
 229 aux =
 230 sources =
 231 objects =
 232 headers =