summaryrefslogtreecommitdiffabout
path: root/doc/Makefile.am
blob: f53e47c41257286c5b2feb5240168cd7256cfbb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# This file is part of Wydawca
# Copyright (C) 2007, 2009 Sergey Poznyakoff
#
# Wudawca 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 3 of the License, or (at your option)
# any later version.
#
# Wydawca is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with Wydawca. If not, see <http://www.gnu.org/licenses/>.

info_TEXINFOS=wydawca.texi
wydawca_TEXINFOS=fdl.texi rendition.texi macros.texi

EXTRA_DIST = gendocs_template

clean-local:
	rm -rf manual

# The rendering level is one of PUBLISH, DISTRIB or PROOF.
# Just call `make RENDITION=PROOF [target]' if you want PROOF rendition.
RENDITION = DISTRIB

MAKEINFOFLAGS=-D$(RENDITION)

GENDOCS=gendocs.sh

TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E

# Make sure you set TEXINPUTS.
# TEXINPUTS=/usr/share/texmf/pdftex/plain/misc/ is ok for most distributions
manual:
	TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
	 MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \
	 TEXI2DVI="$(TEXI2DVI) -t @finalout" \
	 $(GENDOCS) $(PACKAGE) '$(PACKAGE_NAME) manual'

# Checking
check-tabs:
	@if test -n "`cat $(info_TEXINFOS) $(wydawca_TEXINFOS) | tr -d -c '\t'`"; then \
		echo "Sources contain tabs; run make untabify"; \
		false; \
	fi

check-sentence-spacing:
	@if grep -q '\.  [@A-Z]' $(info_TEXINFOS) $(wydawca_TEXINFOS); then \
		echo >&2 "Sources contain double-space sentence separators"; \
		echo >&2 "Run make fix-sentence-spacing to fix"; \
	fi

check-format: check-tabs check-sentence-spacing

check-options:
	@check-docs.sh options \
	   '/OPTIONS_BEGIN/,/OPTIONS_END/s/OPTION( *\([^,][^,]*\),.*/\1/pg' \
	   '/@c option --/{s///;s/^\(help\|version\|usage\)//;p}' \
	   $(top_srcdir)/src/cmdline.opt -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS)

check-refs:
	@sed -e = $(info_TEXINFOS) $(wydawca_TEXINFOS) | \
          sed -n 'N;/@FIXME-.*ref/{s/\(^[0-9][0-9]*\).*@FIXME-.*ref{\([^}]*\)}.*/$(info_TEXINFOS):\1: \2/gp}' > $@-t; \
	  if [ -s $@-t ]; then echo "Unresolved cross-references:"; cat $@-t;\
	  fi
	  rm -f $@-t

check-fixmes:
	@sed -e = $(info_TEXINFOS) | \
          sed -n 'N;/@FIXME{/{s/\(^[0-9][0-9]*\).*@FIXME{\([^}]*\).*/$(info_TEXINFOS):\1: \2/gp}' > $@-t; \
	  if [ -s $@-t ]; then echo "Unresolved FIXMEs:"; cat $@-t;\
	  fi
	  rm -f $@-t

check-writeme:
	@grep -Hn @WRITEME $(info_TEXINFOS) $(wydawca_TEXINFOS) > $@-t; \
	if [ -s $@-t ]; then \
	  echo "Empty nodes:"; \
	  cat $@-t; \
	  rm $@-t; \
	  false;\
	else \
          rm $@-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-writeme

check-docs:
	$(MAKE) -k all-check-docs

master-menu:
	emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS)

untabify:
	emacs -batch -l untabify.el $(info_TEXINFOS) $(wydawca_TEXINFOS)

fix-sentence-spacing:
	for file in $(info_TEXINFOS) $(wydawca_TEXINFOS); \
	do \
		if grep -q '\.  [@A-Z]' $$file; then \
			mv $$file $${file}~; \
			sed -r 's/\.  ([@A-Z])/. \1/g' $${file}~ > $$file; \
		fi; \
	done

final: untabify fix-sentence-spacing master-menu

Return to:

Send suggestions and report system problems to the System administrator.