(exclude): Document support for new VCS.

[chaz/tar] / doc / Makefile.am

diff --git a/doc/Makefile.am b/doc/Makefile.am
index d2fed00591c0fdeed01a2d7fb41ef8ddee38304e..1715d3566b9bd38dd6d110e822dfd0a5cb76e83c 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, 2006 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,
@@ -20,6 +20,7 @@
 info_TEXINFOS = tar.texi
 tar_TEXINFOS = \
  dumpdir.texi\
+ tar-snapshot-edit.texi\
  fdl.texi\
  freemanuals.texi\
  genfile.texi\
@@ -30,8 +31,7 @@ tar_TEXINFOS = \
  snapshot.texi\
  sparse.texi\
  value.texi
-EXTRA_DIST = gendocs_template mastermenu.el texify.sed
-DISTCLEANFILES=*.info* 
+EXTRA_DIST = gendocs_template mastermenu.el texify.sed untabify.el
 
 # The rendering level is anyone of PUBLISH, DISTRIB or PROOF.
 # Just call `make RENDITION=PROOF [target]' if you want PROOF rendition.
@@ -46,6 +46,18 @@ header.texi: $(top_srcdir)/src/tar.h
 master-menu: $(tar_TEXINFOS)
        emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS)
 
+untabify:
+       emacs -batch -l untabify.el $(info_TEXINFOS) $(tar_TEXINFOS)
+
+final: untabify master-menu
+
+# Checking
+check-format:
+       @if test -n "`cat $(info_TEXINFOS) $(tar_TEXINFOS) | tr -d -c '\t'`"; then \
+               echo "Sources contain tabs; run make untabify"; \
+               false; \
+       fi
+
 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' \
@@ -67,6 +79,52 @@ doc-opt-col=0,opt-doc-col=0,header-col=0,rmargin=1' \
         fi;\
         rm report.$$$$
 
+check-refs:
+       @for file in $(info_TEXINFOS) $(tar_TEXINFOS); \
+       do \
+         sed -e = $$file | \
+           sed -n 'N;/@FIXME-.*ref/{s/\(^[0-9][0-9]*\).*@FIXME-.*ref{\([^}]*\).*/'$$file':\1: \2/gp}'; \
+       done > $@-t; \
+       if [ -s $@-t ]; then \
+         echo "Unresolved cross-references:"; \
+         cat $@-t;\
+         rm $@-t; \
+       else \
+         rm -f $@-t; \
+       fi
+
+check-fixmes:
+       @for file in $(info_TEXINFOS); \
+       do \
+         sed -e = $$file | \
+           sed -n 'N;/@FIXME{/{s/\(^[0-9][0-9]*\).*@FIXME{\([^}]*\).*/'$$file':\1: \2/gp}'; \
+       done > $@-t; \
+       if [ -s $@-t ]; then \
+         echo "Unresolved FIXMEs:"; \
+         cat $@-t; \
+         rm $@-t; \
+         false; \
+       else \
+          rm -f $@-t; \
+       fi
+
+check-unrevised:
+       @grep -Hn @UNREVISED $(info_TEXINFOS) > $@-t; \
+       if [ -s $@-t ]; then \
+         echo "Unrevised nodes:"; \
+         cat $@-t; \
+         rm $@-t; \
+         false;\
+       else \
+          rm $@-t; \
+       fi
+
+all-check-docs: check-format check-options check-refs check-fixmes check-unrevised
+
+check-docs: 
+       $(MAKE) -k all-check-docs
+
+#
 
 clean-local:
        rm -rf manual
@@ -79,8 +137,8 @@ TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
 # 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'
+       $(GENDOCS) --texi2html tar 'GNU tar manual'