summaryrefslogtreecommitdiffabout
path: root/doc/Makefile.am
blob: 9dd98a053d74b38427ad197af9269ec035ef2782 (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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# This file is part of Mailfromd.
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011 Sergey
# Poznyakoff
#
# Mailfromd 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, or (at your option)
# any later version.
#
# Mailfromd 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 Mailfromd.  If not, see <http://www.gnu.org/licenses/>.

info_TEXINFOS=mailfromd.texi
mailfromd_TEXINFOS=\
 calloutd.texi\
 fdl.texi\
 functions.texi\
 gacopyz.texi\
 macros.texi\
 mfdbtool.texi\
 mtasim.texi\
 pmult.texi\
 rendition.texi\
 sexp.texi\
 strftime.texi\
 upgrade.texi

EXTRA_DIST = \
 check-docs.sh\
 gendocs_template\
 mastermenu.el\
 untabify.el

clean-local:
	@rm -rf manual

AM_MAKEINFOFLAGS = -I $(top_srcdir)

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

check-options: check-mailfromd-options check-calloutd-options check-mfdbtool-options

check-mailfromd-options:
	@check-docs.sh "mailfromd options" \
	   '/argp_option options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   's/@opindex *\([^@,]*\), --.*mailfromd option.*/\1/p' \
	   $(top_srcdir)/src/main.c -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-calloutd-options:
	@check-docs.sh "calloutd options" \
	   '/argp_option options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   's/@opindex *\([^@,]*\), --.*calloutd option.*/\1/p' \
	   $(top_srcdir)/src/calloutd.c -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-mfdbtool-options:
	@check-docs.sh "mfdbtool options" \
	   '/argp_option options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   's/@opindex *\([^@,]*\), --.*mfdbtool option.*/\1/p' \
	   $(top_srcdir)/src/mfdbtool.c -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-config:
	@check-docs.sh 'configuration statements' \
	   '/mf_cfg_param\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   's/@deffn {Mailfromd Conf} *\([^@,]*\).*/\1/p' \
	   $(top_srcdir)/src/main.c $(top_srcdir)/lib/dbcfg.c -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-sub-config:
	@list=`sed -n '/mf_cfg_param\[\] *= *{/,/^}/{s/[ \t]*{ *"\([^,"]*\)", *mu_cfg_section *,.*/\1/pg}' $(top_srcdir)/src/main.c | sed /^runtime$$/d`; \
	for ident in $$list; do \
	   cident=`echo $$ident | tr '-' '_'`; \
	   check-docs.sh "$$ident configuration statements" \
	   "/$${cident}_section_param"'\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   "s/@deffn {$${ident}}"' *\([^@,]*\).*/\1/p' \
	   $(top_srcdir)/src/main.c $(top_srcdir)/lib/dbcfg.c -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS); \
        done

# FIXME: This rule does not take into account possible subsections.
# None of the *.bi sources declares them anyway, so it's OK for now.
check-runtime-config:
	@check-docs.sh 'MFL runtime configuration statements' \
	   '/struct  *mu_cfg_param  *[a-zA-Z_][a-zA-Z0-9_]*_cfg_param\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
	   's/@deffn {runtime} *\([^@, ]*\).*/\1/p' \
	   $(top_srcdir)/src/builtin/*.bi -- \
	   $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-builtins:
	@check-docs.sh builtins \
    '/MF_DEFUN/{s/[ \t]*MF_DEFUN *(\([a-zA-Z_][a-zA-Z0-9_]*\),.*/\1/p;s/[ \t]*MF_DEFUN_VARARGS\(_NO_PROM\)\? *(\([a-zA-Z_][a-zA-Z0-9_]*\),.*/\2/p;s/[ \t]*MF_DEFUN_CTYPE *(\([a-zA-Z_][a-zA-Z0-9_]*\))/\1/p}'\
    's/@deftypefnx\{0,1\} {Built-in Function} *[^ ][^ ]* *\([^ ]*\).*/\1/p' \
    $(top_srcdir)/src/builtin/*.bi -- \
       $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-mflib:
	@check-docs.sh "library functions" \
    '/^[ \t]*func[ \t][ \t]*__/b;/^[ \t]*func/s/[ \t]*func[ \t][ \t]*\(.[^ \t(]*\).*/\1/p' \
    's/@deftypefn {Library Function} *[^ ][^ ]* *\([^ ]*\).*/\1/p' \
    $(top_srcdir)/mflib/*.mf -- \
       $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS)

check-exceptions:
	@check-docs.sh exceptions \
     '/dclex e_/s/dclex \(e_[^ ]*\)/\1/p' \
     's/@cindex \(e_[^,]*\), exception type/\1/p'	\
     $(top_srcdir)/mflib/status.mf -- \
       $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-pragmas:
	@check-docs.sh pragmas \
     '/MF_PRAGMA(/s/MF_PRAGMA(\(.[^,]*\),.*/\1/p;/install_pragma/s/install_pragma("\(.*\)".*/\1/p' \
     's/@subsection Pragma \(.*\)/\1/p' \
     $(top_srcdir)/src/builtin/*.bi $(top_srcdir)/src/gram.y -- \
       $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
		$(info_TEXINFOS) 

check-refs:
	@for file in $(info_TEXINFOS) $(mailfromd_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) $(mailfromd_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-writeme:
	@grep -Hn @WRITEME $(info_TEXINFOS) $(mailfromd_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) $(mailfromd_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-pragmas \
                check-config check-sub-config check-runtime-config \
                check-builtins check-mflib check-exceptions \
                check-refs check-fixmes check-writeme check-unrevised

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

#

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

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

final: untabify master-menu

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

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
.PHONY: manual
manual:
	TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
	 MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \
	 TEXI2DVI="$(TEXI2DVI) -t @finalout" \
	 $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual'

manual.tar.bz2: manual
	tar cfj manual.tar.bz2 manual

man-tar: manual.tar.bz2

Return to:

Send suggestions and report system problems to the System administrator.