aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2015-03-02 15:26:37 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2015-03-02 15:30:23 +0200
commit90b1ab9fcdbe3b36b09d9adb5d9517686a020ae4 (patch)
treec1bcc75ffe35c9ddc3e021abe7fb2344defa24cf
parenta70bcfca1a87c66dd7a85e45f2b802275da66ada (diff)
downloadcflow-90b1ab9fcdbe3b36b09d9adb5d9517686a020ae4.tar.gz
cflow-90b1ab9fcdbe3b36b09d9adb5d9517686a020ae4.tar.bz2
Switch to Texinfo 5 and Imprimatur
* .gitmodules: Add imprimatur as a submodule. * Makefile.am: Update ACLOCAL_AMFLAGS * configure.ac: Initialize imprimatur * doc/Makefile.am: Likewise. * doc/gendocs.sh: New file. * doc/rendition.texi: Remove.
-rw-r--r--.gitignore3
-rw-r--r--.gitmodules3
-rw-r--r--Makefile.am4
-rw-r--r--configure.ac18
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/Makefile.am20
-rwxr-xr-xdoc/gendocs.sh490
m---------doc/imprimatur0
-rw-r--r--doc/rendition.texi94
9 files changed, 511 insertions, 122 deletions
diff --git a/.gitignore b/.gitignore
index 05b122b..f1f5f69 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,11 +4,12 @@
4*.o 4*.o
5*.so 5*.so
6*.tar.bz2 6*.tar.bz2
7*.tar.gz 7*.tar.[gx]z
8*~ 8*~
9.bootstrap 9.bootstrap
10.deps 10.deps
11.emacs.desktop 11.emacs.desktop
12.gdbinit
12ABOUT-NLS 13ABOUT-NLS
13ChangeLog 14ChangeLog
14INSTALL 15INSTALL
diff --git a/.gitmodules b/.gitmodules
index acb2669..7e92206 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,6 @@
1[submodule "gnulib"] 1[submodule "gnulib"]
2 path = gnulib 2 path = gnulib
3 url = git://git.sv.gnu.org/gnulib.git 3 url = git://git.sv.gnu.org/gnulib.git
4[submodule "doc/imprimatur"]
5 path = doc/imprimatur
6 url = git://git.gnu.org.ua/imprimatur.git
diff --git a/Makefile.am b/Makefile.am
index 400753b..953ee50 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,5 +1,5 @@
1# This file is part of GNU cflow 1# This file is part of GNU cflow
2# Copyright (C) 2005, 2007, 2009 Free Software Foundation, Inc. 2# Copyright (C) 2005, 2007, 2009, 2015 Free Software Foundation, Inc.
3# 3#
4# Written by Sergey Poznyakoff 4# Written by Sergey Poznyakoff
5# 5#
@@ -16,7 +16,7 @@
16# You should have received a copy of the GNU General Public License 16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>. 17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18 18
19ACLOCAL_AMFLAGS = -I m4 19ACLOCAL_AMFLAGS = -I m4 -I doc/imprimatur
20 20
21SUBDIRS = gnu src elisp po doc tests 21SUBDIRS = gnu src elisp po doc tests
22 22
diff --git a/configure.ac b/configure.ac
index 7dfd109..2a2d222 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,5 +1,5 @@
1# This file is part of GNU cflow 1# This file is part of GNU cflow
2# Copyright (C) 2005, 2007, 2009, 2011, 2014 Free Software Foundation, Inc. 2# Copyright (C) 2005, 2007, 2009, 2011, 2014, 2015 Free Software Foundation, Inc.
3# 3#
4# Written by Sergey Poznyakoff 4# Written by Sergey Poznyakoff
5# 5#
@@ -58,21 +58,7 @@ AM_ICONV
58AM_GNU_GETTEXT([external], [need-formatstring-macros]) 58AM_GNU_GETTEXT([external], [need-formatstring-macros])
59AM_GNU_GETTEXT_VERSION(0.17) 59AM_GNU_GETTEXT_VERSION(0.17)
60 60
61# Select a rendition level: 61IMPRIMATUR_INIT(doc/imprimatur)
62# DISTRIB for stable releases (at most one dot in the version number)
63# and maintenance releases (two dots, patchlevel < 50)
64# PROOF for alpha releases.
65# PUBLISH can only be required manually when running make in doc/
66AC_SUBST(RENDITION)
67case `echo $VERSION|sed 's/[[^.]]//g'` in
68""|".") RENDITION=DISTRIB;;
69"..") if test `echo $VERSION | sed 's/.*\.//'` -lt 50; then
70 RENDITION=DISTRIB
71 else
72 RENDITION=PROOF
73 fi;;
74*) RENDITION=PROOF;;
75esac
76 62
77### Initialize the test suite. 63### Initialize the test suite.
78AC_CONFIG_TESTDIR(tests) 64AC_CONFIG_TESTDIR(tests)
diff --git a/doc/.gitignore b/doc/.gitignore
index bf6d398..9e56132 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -22,3 +22,4 @@ cflow.cps
22cflow.fns 22cflow.fns
23cflow.pdf 23cflow.pdf
24cflow.pgs 24cflow.pgs
25manual
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2fda397..8da86f7 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
1# This file is part of GNU cflow 1# This file is part of GNU cflow
2# Copyright (C) 2005, 2007, 2014 Free Software Foundation, Inc. 2# Copyright (C) 2005, 2007, 2014, 2015 Free Software Foundation, Inc.
3# 3#
4# Written by Sergey Poznyakoff 4# Written by Sergey Poznyakoff
5# 5#
@@ -16,29 +16,31 @@
16# You should have received a copy of the GNU General Public License 16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>. 17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18 18
19SUBDIRS = . imprimatur
20
19info_TEXINFOS=cflow.texi 21info_TEXINFOS=cflow.texi
20cflow_TEXINFOS=fdl.texi rendition.texi 22cflow_TEXINFOS=fdl.texi
21dist_man_MANS=cflow.1 23dist_man_MANS=cflow.1
22 24
23EXTRA_DIST = gendocs_template ack.c d.c wc.c whoami.c foo.c 25EXTRA_DIST = gendocs.sh gendocs_template ack.c d.c wc.c whoami.c foo.c
24 26
25clean-local: 27clean-local:
26 rm -rf manual 28 rm -rf manual
27 29
28# The rendering level is one of PUBLISH, DISTRIB or PROOF. 30AM_MAKEINFOFLAGS=@IMPRIMATUR_MAKEINFOFLAGS@
29# Just call `make RENDITION=PROOF [target]' if you want PROOF rendition. 31imprimatur_INPUT=$(info_TEXINFOS) $(cflow_TEXINFOS)
30 32# CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh
31MAKEINFOFLAGS=-D$(RENDITION)
32 33
33GENDOCS=gendocs.sh 34GENDOCS=$(srcdir)/gendocs.sh
34 35
35TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E 36TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
36 37
37# Make sure you set TEXINPUTS. 38# Make sure you set TEXINPUTS.
38# TEXINPUTS=/usr/share/texmf/pdftex/plain/misc/ is ok for most distributions 39# TEXINPUTS=/usr/share/texmf/pdftex/plain/misc/ is ok for most distributions
40.PHONY: manual
39manual: 41manual:
40 TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \ 42 TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
41 MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \ 43 MAKEINFO="$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS)" \
42 TEXI2DVI="$(TEXI2DVI) -t @finalout" \ 44 TEXI2DVI="$(TEXI2DVI) -t @finalout" \
43 $(GENDOCS) $(PACKAGE) '$(PACKAGE_NAME) manual' 45 $(GENDOCS) $(PACKAGE) '$(PACKAGE_NAME) manual'
44 46
diff --git a/doc/gendocs.sh b/doc/gendocs.sh
new file mode 100755
index 0000000..8ac3a06
--- /dev/null
+++ b/doc/gendocs.sh
@@ -0,0 +1,490 @@
1#!/bin/sh -e
2# gendocs.sh -- generate a GNU manual in many formats. This script is
3# mentioned in maintain.texi. See the help message below for usage details.
4
5scriptversion=2015-02-28.17
6
7# Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
8# Free Software Foundation, Inc.
9#
10# This program is free software: you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 3 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program. If not, see <http://www.gnu.org/licenses/>.
22#
23# Original author: Mohit Agarwal.
24# Send bug reports and any other correspondence to bug-texinfo@gnu.org.
25#
26# The latest version of this script, and the companion template, is
27# available from Texinfo CVS:
28# http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh
29# http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template
30#
31# An up-to-date copy is also maintained in Gnulib (gnu.org/software/gnulib).
32
33# TODO:
34# - image importation was only implemented for HTML generated by
35# makeinfo. But it should be simple enough to adjust.
36# - images are not imported in the source tarball. All the needed
37# formats (PDF, PNG, etc.) should be included.
38
39prog=`basename "$0"`
40srcdir=`pwd`
41
42scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
43templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
44
45: ${SETLANG="env LANG= LC_MESSAGES= LC_ALL= LANGUAGE="}
46: ${MAKEINFO="makeinfo"}
47: ${TEXI2DVI="texi2dvi -t @finalout"}
48: ${DOCBOOK2HTML="docbook2html"}
49: ${DOCBOOK2PDF="docbook2pdf"}
50: ${DOCBOOK2TXT="docbook2txt"}
51: ${GENDOCS_TEMPLATE_DIR="."}
52: ${PERL='perl'}
53: ${TEXI2HTML="texi2html"}
54unset CDPATH
55unset use_texi2html
56
57version="gendocs.sh $scriptversion
58
59Copyright 2013 Free Software Foundation, Inc.
60There is NO warranty. You may redistribute this software
61under the terms of the GNU General Public License.
62For more information about these matters, see the files named COPYING."
63
64usage="Usage: $prog [OPTION]... PACKAGE MANUAL-TITLE
65
66Generate output in various formats from PACKAGE.texinfo (or .texi or
67.txi) source. See the GNU Maintainers document for a more extensive
68discussion:
69 http://www.gnu.org/prep/maintain_toc.html
70
71Options:
72 --email ADR use ADR as contact in generated web pages; always give this.
73
74 -s SRCFILE read Texinfo from SRCFILE, instead of PACKAGE.{texinfo|texi|txi}
75 -o OUTDIR write files into OUTDIR, instead of manual/.
76 -I DIR append DIR to the Texinfo search path.
77 --common ARG pass ARG in all invocations.
78 --html ARG pass ARG to makeinfo or texi2html for HTML targets.
79 --info ARG pass ARG to makeinfo for Info, instead of --no-split.
80 --no-ascii skip generating the plain text output.
81