1 # Makefile for GNU tar documentation.
3 # Copyright 1994-1997, 1999-2001, 2003, 2006-2007, 2013 Free Software
6 # This file is part of GNU tar.
8 # GNU tar is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # GNU tar is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 info_TEXINFOS = tar.texi
24 tar-snapshot-edit.texi\
36 dist_man_MANS=tar.1 rmt.8
38 EXTRA_DIST = gendocs_template mastermenu.el texify.sed untabify.el
40 # The rendering level is anyone of PUBLISH, DISTRIB or PROOF.
41 # Just call 'make RENDITION=PROOF [target]' if you want PROOF rendition.
44 MAKEINFOFLAGS=-D$(RENDITION)
46 header.texi: $(top_srcdir)/src/tar.h
47 sed -f $(srcdir)/texify.sed $(top_srcdir)/src/tar.h \
50 master-menu: $(tar_TEXINFOS)
51 emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS)
54 emacs -batch -l untabify.el $(info_TEXINFOS) $(tar_TEXINFOS)
56 final: untabify master-menu
60 @if test -n "`cat $(info_TEXINFOS) $(tar_TEXINFOS) | tr -d -c '\t'`"; then \
61 echo "Sources contain tabs; run make untabify"; \
66 @ARGP_HELP_FMT='usage-indent=0,short-opt-col=0,long-opt-col=0,doc-opt-col=0,opt-doc-col=0,header-col=0,rmargin=1' \
67 $(top_builddir)/src/tar --usage | \
68 sed -n 's/^\[--\([^]\=\[]*\).*/\1/p' | sort | uniq > opts.$$$$;\
69 $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
71 sed -n '/^@macro/,/^@end macro/d;s/@opindex *\([^@,]*\).*/\1/p' \
72 | sort | uniq > docs.$$$$;\
74 join -v1 opts.$$$$ docs.$$$$ > report.$$$$;\
75 if test -s report.$$$$; then \
76 echo 'Not documented options:'; \
80 join -v2 opts.$$$$ docs.$$$$ > report.$$$$;\
81 if test -s report.$$$$; then \
82 echo 'Non-existing options:';\
86 rm opts.$$$$ docs.$$$$ report.$$$$;\
87 test $$status -ne 0 && exit $$status
90 @for file in $(info_TEXINFOS) $(tar_TEXINFOS); \
93 sed -n 'N;/@FIXME-.*ref/{s/\(^[0-9][0-9]*\).*@FIXME-.*ref{\([^}]*\).*/'$$file':\1: \2/gp}'; \
95 if [ -s $@-t ]; then \
96 echo "Unresolved cross-references:"; \
104 @for file in $(info_TEXINFOS); \
107 sed -n 'N;/@FIXME{/{s/\(^[0-9][0-9]*\).*@FIXME{\([^}]*\).*/'$$file':\1: \2/gp}'; \
109 if [ -s $@-t ]; then \
110 echo "Unresolved FIXMEs:"; \
119 @grep -Hn @UNREVISED $(info_TEXINFOS) > $@-t; \
120 if [ -s $@-t ]; then \
121 echo "Unrevised nodes:"; \
129 all-check-docs: check-format check-options check-refs check-fixmes check-unrevised
132 $(MAKE) -k all-check-docs
141 TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
143 # Make sure you set TEXINPUTS
145 # /usr/share/texmf/pdftex/plain/misc:/usr/share/texmf/pdftex/config
147 TEXINPUTS=$(srcdir):$(top_srcdir)/build-tex:$(TEXINPUTS) \
148 MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \
149 TEXI2DVI="$(TEXI2DVI) -t @finalout" \
150 $(GENDOCS) --texi2html tar 'GNU tar manual'