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
|
# This file is part of Mailfromd.
# Copyright (C) 2005-2025 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\
filter_pipe.texi\
functions.texi\
gacopyz.texi\
macros.texi\
mfdbtool.texi\
mtasim.texi\
pmult.texi\
strftime.texi\
upgrade.texi
EXTRA_DIST = gendocs.pl webdoc.init otherdoc.texi.in
clean-local:
@rm -rf manual
AM_MAKEINFOFLAGS = -I $(abs_top_srcdir) @IMPRIMATUR_MAKEINFOFLAGS@
# Imprimatur setup
imprimatur_INPUT=$(info_TEXINFOS) $(mailfromd_TEXINFOS)
include ../imprimatur/imprimatur.mk
CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh
# Checking
check-options: check-mailfromd-options check-calloutd-options check-mfdbtool-options
# FIXME: Options log-facility and mailer are added by the corresponding
# mailutils capabilities. The check is unable to trace that.
check-mailfromd-options:
@$(CHECK_DOCS) "mailfromd options" \
'/mu_option mailfromd_options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg;/mu_option srv_options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
's/@opindex *\([^@,]*\), --.*mailfromd option.*/\1/p' \
$(top_srcdir)/src/main.c $(top_srcdir)/src/srvcfg.c -- \
$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
$(info_TEXINFOS)
# FIXME: Same here
check-calloutd-options:
@$(CHECK_DOCS) "calloutd options" \
'/mu_option calloutd_options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg;/mu_option srv_options\[\] = /,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
's/@opindex *\([^@,]*\), --.*calloutd option.*/\1/p' \
$(top_srcdir)/src/calloutd.c $(top_srcdir)/src/srvcfg.c -- \
$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
$(info_TEXINFOS)
check-mfdbtool-options:
@$(CHECK_DOCS) "mfdbtool options" \
'/mu_option mfdbtool_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) 'configuration statements' \
'/mf_cfg_param\[\] *= *{/,/^}/s/[ \t]*{ *"\([a-zA-Z_][^,"]*\)".*/\1/pg;/srv_cfg_param\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
's/@deffn {Mailfromd Conf} *\([^@, ]*\).*/\1/p' \
$(top_srcdir)/src/main.c $(top_srcdir)/src/srvcfg.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) "$$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) '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) 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) "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) 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) 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)
all-check-docs: imprimatur-basic-checks check-options check-pragmas \
check-config check-sub-config check-runtime-config \
check-builtins check-mflib check-exceptions
check-docs:
@$(MAKE) -k all-check-docs
#
master-menu: imprimatur-master-menu
untabify: imprimatur-untabify
final: imprimatur-final
GENDOCS=perl gendocs.pl
TEXI2DVI=texi2dvi --build=tidy -t '@set $(RENDITION)' -I $(abs_top_srcdir) -I $(top_srcdir)/imprimatur
.PHONY: manual
manual:
rm -rf manual
TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
TEXI2DVI="$(TEXI2DVI)" \
MAKEINFO="$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS)" \
$(GENDOCS) -C manual -o otherdoc.texi --init-file=otherdoc.init $(PACKAGE) otherdoc.texi.in
$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -DWEBDOC \
--html --init-file=webdoc.init $(info_TEXINFOS) -o manual
manual.tar.bz2: manual
tar cfj manual.tar.bz2 manual
man-tar: manual.tar.bz2
|