Document version 2

[chaz/tar] / doc / Makefile.am

diff --git a/doc/Makefile.am b/doc/Makefile.am
index d3b51b084e31b9e4a92113c368f2f1ec7f4d4326..232d2ea3935cfbcc9d90b18e1fd5fd83de6d855c 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,11 +1,11 @@
 # Makefile for GNU tar documentation.
 
-# Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2003 Free
-# Software Foundation, Inc.
+# Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2003, 2006,
+# 2007 Free Software Foundation, Inc.
 
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2, or (at your option)
+## the Free Software Foundation; either version 3, or (at your option)
 ## any later version.
 
 ## This program is distributed in the hope that it will be useful,
@@ -15,12 +15,23 @@
 
 ## You should have received a copy of the GNU General Public License
 ## along with this program; if not, write to the Free Software Foundation,
-## Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+## Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 info_TEXINFOS = tar.texi
-tar_TEXINFOS = fdl.texi freemanuals.texi getdate.texi header.texi
-EXTRA_DIST = convtexi.pl gendocs_template 
-DISTCLEANFILES=*.info* 
+tar_TEXINFOS = \
+ dumpdir.texi\
+ tar-snapshot-edit.texi\
+ fdl.texi\
+ freemanuals.texi\
+ genfile.texi\
+ getdate.texi\
+ header.texi\
+ intern.texi\
+ rendition.texi\
+ snapshot.texi\
+ sparse.texi\
+ value.texi
+EXTRA_DIST = gendocs_template mastermenu.el texify.sed
 
 # The rendering level is anyone of PUBLISH, DISTRIB or PROOF.
 # Just call `make RENDITION=PROOF [target]' if you want PROOF rendition.
@@ -29,8 +40,33 @@ RENDITION = DISTRIB
 MAKEINFOFLAGS=-D$(RENDITION)
 
 header.texi: $(top_srcdir)/src/tar.h
-       sed -n '/Archive Format/,/End of Format/p' $(top_srcdir)/src/tar.h \
-         | expand | sed 's/\([{}]\)/@\1/g' >$@
+       sed -f $(srcdir)/texify.sed $(top_srcdir)/src/tar.h \
+         | expand >$@
+
+master-menu: $(tar_TEXINFOS)
+       emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS)
+
+check-options:
+       @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' \
+       $(top_builddir)/src/tar --usage | \
+       sed -n 's/^\[--\([^]\=\[]*\).*/\1/p' | sort | uniq > opts.$$$$;\
+       $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
+            $(info_TEXINFOS) | \
+       sed -n '/^@macro/,/^@end macro/d;s/@opindex *\([^@,]*\).*/\1/p' \
+            | sort | uniq > docs.$$$$;\
+       (echo 'Not documented options:';\
+        join -v1 opts.$$$$ docs.$$$$;\
+        echo 'Non-existing options:';\
+        join -v2 opts.$$$$ docs.$$$$) > report.$$$$;\
+        rm opts.$$$$ docs.$$$$;\
+        if [ -n "`sed '1,2d' report.$$$$`" ]; then \
+          cat report.$$$$;\
+          rm report.$$$$;\
+          exit 1;\
+        fi;\
+        rm report.$$$$
+
 
 clean-local:
        rm -rf manual
@@ -40,8 +76,10 @@ GENDOCS=gendocs.sh
 TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
 
 # Make sure you set TEXINPUTS
+# Usual value is:
+# /usr/share/texmf/pdftex/plain/misc:/usr/share/texmf/pdftex/config
 manual:
-       TEXINPUTS=$(srcdir):$(top_srcdir)/config:$(TEXINPUTS) \
+       TEXINPUTS=$(srcdir):$(top_srcdir)/build-tex:$(TEXINPUTS) \
         MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \
         TEXI2DVI="$(TEXI2DVI) -t @finalout" \
        $(GENDOCS) tar 'GNU tar manual'