summaryrefslogtreecommitdiffabout
path: root/doc/Makefile.am
blob: 96ba74d0c7b79f8816f19b78a9b7e29d83d67f5b (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
# This file is part of GDBM.                                   -*- Makefile -*-
# Copyright (C) 2007, 2011, 2014-2019 Free Software Foundation, Inc.
#
# GDBM 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.
#
# GDBM 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 GDBM. If not, see <http://www.gnu.org/licenses/>. */

# Documentation

info_TEXINFOS = gdbm.texi
gdbm_TEXINFOS=\
  fdl.texi

dist_man_MANS   = gdbm.3 gdbm_dump.1 gdbm_load.1 gdbmtool.1

GENDOCS=$(srcdir)/gendocs.sh --no-copy-images --html '--init-file=$(abs_srcdir)/html.init'

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

# 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) --no-copy-images $(PACKAGE) '$(PACKAGE_NAME) manual'

# Checking
check-tabs:
	@if test -n "`cat $(info_TEXINFOS) $(gdbm_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) $(gdbm_TEXINFOS); then \
		echo >&2 "Sources contain single-space sentence separators"; \
		echo >&2 "Run make fix-sentence-spacing to fix"; \
	fi

check-fixmes:
	@for file in $(info_TEXINFOS) $(gdbm_TEXINFOS); \
	do \
	  sed -e = $$file | \
           sed -n 'N;/@c  *FIXME:/{s/\(^[0-9][0-9]*\).*@c  *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-format: check-tabs check-sentence-spacing

check-docs: check-format check-fixmes

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

fix-sentence-spacing:
	for file in $(info_TEXINFOS) $(gdbm_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

Return to:

Send suggestions and report system problems to the System administrator.