[thirdparty/git.git] / Documentation / Makefile

MAN1_TXT= \
	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
		$(wildcard git-*.txt)) \
	gitk.txt git.txt
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
	gitrepository-layout.txt
MAN7_TXT=gitcli.txt gittutorial.txt gittutorial-2.txt \
	gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
	gitdiffcore.txt gitworkflows.txt

MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))

DOC_HTML=$(MAN_HTML)

ARTICLES = howto-index
ARTICLES += everyday
ARTICLES += git-tools
# with their own formatting rules.
SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
SP_ARTICLES += $(API_DOCS)
SP_ARTICLES += technical/api-index

DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))

DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))

prefix?=$(HOME)
bindir?=$(prefix)/bin
htmldir?=$(prefix)/share/doc/git-doc
pdfdir?=$(prefix)/share/doc/git-doc
mandir?=$(prefix)/share/man
man1dir=$(mandir)/man1
man5dir=$(mandir)/man5
man7dir=$(mandir)/man7
# DESTDIR=

ASCIIDOC=asciidoc
ASCIIDOC_EXTRA =
MANPAGE_XSL = manpage-normal.xsl
XMLTO_EXTRA =
INSTALL?=install
RM ?= rm -f
DOC_REF = origin/man
HTML_REF = origin/html

infodir?=$(prefix)/share/info
MAKEINFO=makeinfo
INSTALL_INFO=install-info
DOCBOOK2X_TEXI=docbook2x-texi
DBLATEX=dblatex
ifndef PERL_PATH
	PERL_PATH = /usr/bin/perl
endif

-include ../config.mak.autogen
-include ../config.mak

#
# For asciidoc ...
#	-7.1.2,	no extra settings are needed.
#	8.0-,	set ASCIIDOC8.
#

#
# For docbook-xsl ...
#	-1.68.1,	set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
#	1.69.0,		no extra settings are needed?
#	1.69.1-1.71.0,	set DOCBOOK_SUPPRESS_SP?
#	1.71.1,		no extra settings are needed?
#	1.72.0,		set DOCBOOK_XSL_172.
#	1.73.0-,	set ASCIIDOC_NO_ROFF
#

#
# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
# of 'the ".ft C" problem' in your generated manpages, and you
# instead ended up with weird characters around callouts, try
# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
#

ifdef ASCIIDOC8
ASCIIDOC_EXTRA += -a asciidoc7compatible
endif
ifdef DOCBOOK_XSL_172
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
MANPAGE_XSL = manpage-1.72.xsl
else
	ifdef ASCIIDOC_NO_ROFF
	# docbook-xsl after 1.72 needs the regular XSL, but will not
	# pass-thru raw roff codes from asciidoc.conf, so turn them off.
	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
	endif
endif
ifdef MAN_BOLD_LITERAL
XMLTO_EXTRA += -m manpage-bold-literal.xsl
endif
ifdef DOCBOOK_SUPPRESS_SP
XMLTO_EXTRA += -m manpage-suppress-sp.xsl
endif

SHELL_PATH ?= $(SHELL)
# Shell quote;
SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))

#
# Please note that there is a minor bug in asciidoc.
# The version after 6.0.3 _will_ include the patch found here:
#   http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
#
# Until that version is released you may have to apply the patch
# yourself - yes, all 6 characters of it!
#

QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
QUIET_SUBDIR1  =

ifneq ($(findstring $(MAKEFLAGS),w),w)
PRINT_DIR = --no-print-directory
else # "make -w"
NO_SUBDIR = :
endif

ifneq ($(findstring $(MAKEFLAGS),s),s)
ifndef V
	QUIET_ASCIIDOC	= @echo '   ' ASCIIDOC $@;
	QUIET_XMLTO	= @echo '   ' XMLTO $@;
	QUIET_DB2TEXI	= @echo '   ' DB2TEXI $@;
	QUIET_MAKEINFO	= @echo '   ' MAKEINFO $@;
	QUIET_DBLATEX	= @echo '   ' DBLATEX $@;
	QUIET_XSLTPROC	= @echo '   ' XSLTPROC $@;
	QUIET_GEN	= @echo '   ' GEN $@;
	QUIET_STDERR	= 2> /dev/null
	QUIET_SUBDIR0	= +@subdir=
	QUIET_SUBDIR1	= ;$(NO_SUBDIR) echo '   ' SUBDIR $$subdir; \
			  $(MAKE) $(PRINT_DIR) -C $$subdir
	export V
endif
endif

all: html man

html: $(DOC_HTML)

$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf

man: man1 man5 man7
man1: $(DOC_MAN1)
man5: $(DOC_MAN5)
man7: $(DOC_MAN7)

info: git.info gitman.info

pdf: user-manual.pdf

install: install-man

install-man: man
	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
	$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
	$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)

install-info: info
	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
	$(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
	if test -r $(DESTDIR)$(infodir)/dir; then \
	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
	else \
	  echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
	fi

install-pdf: pdf
	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)

install-html: html
	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)

../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE

-include ../GIT-VERSION-FILE

#
# Determine "include::" file references in asciidoc files.
#
doc.dep : $(wildcard *.txt) build-docdep.perl
	$(QUIET_GEN)$(RM) $@+ $@ && \
	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
	mv $@+ $@

-include doc.dep

cmds_txt = cmds-ancillaryinterrogators.txt \
	cmds-ancillarymanipulators.txt \
	cmds-mainporcelain.txt \
	cmds-plumbinginterrogators.txt \
	cmds-plumbingmanipulators.txt \
	cmds-synchingrepositories.txt \
	cmds-synchelpers.txt \
	cmds-purehelpers.txt \
	cmds-foreignscminterface.txt

$(cmds_txt): cmd-list.made

cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
	$(QUIET_GEN)$(RM) $@ && \
	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
	date >$@

clean:
	$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
	$(RM) *.texi *.texi+ *.texi++ git.info gitman.info
	$(RM) howto-index.txt howto/*.html doc.dep
	$(RM) technical/api-*.html technical/api-index.txt
	$(RM) $(cmds_txt) *.made

$(MAN_HTML): %.html : %.txt
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
		$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
	mv $@+ $@

%.1 %.5 %.7 : %.xml
	$(QUIET_XMLTO)$(RM) $@ && \
	xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<

%.xml : %.txt
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
		$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
	mv $@+ $@

user-manual.xml: user-manual.txt user-manual.conf
	$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book $<

technical/api-index.txt: technical/api-index-skel.txt \
	technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
	$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh

$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
	$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
		$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt

XSLT = docbook.xsl
XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css

user-manual.html: user-manual.xml
	$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<

git.info: user-manual.texi
	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi

user-manual.texi: user-manual.xml
	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
	rm $@++ && \
	mv $@+ $@

user-manual.pdf: user-manual.xml
	$(QUIET_DBLATEX)$(RM) $@+ $@ && \
	$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
	mv $@+ $@

gitman.texi: $(MAN_XML) cat-texi.perl
	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
		--to-stdout $(xml) &&) true) > $@++ && \
	$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
	rm $@++ && \
	mv $@+ $@

gitman.info: gitman.texi
	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi

$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
	mv $@+ $@

howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
	$(QUIET_GEN)$(RM) $@+ $@ && \
	'$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
	mv $@+ $@

$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
	$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt

WEBDOC_DEST = /pub/software/scm/git/docs

$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
	mv $@+ $@

install-webdoc : html
	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)

quick-install: quick-install-man

quick-install-man:
	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)

quick-install-html:
	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)

.PHONY: .FORCE-GIT-VERSION-FILE
Commit	Line	Data
4a5d6939 MW	1	MAN1_TXT= \
	2	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
	3	$(wildcard git-*.txt)) \
9e1f0a85	4	gitk.txt git.txt
30eba7bf CC	5	MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt \
30eba7bf CC	6	gitrepository-layout.txt
9e1f0a85	7	MAN7_TXT=gitcli.txt gittutorial.txt gittutorial-2.txt \
30eba7bf	8	gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt \
f948dd89	9	gitdiffcore.txt gitworkflows.txt
b790abb8	10
5cefc33b JH	11	MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
	12	MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
	13	MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
	14
	15	DOC_HTML=$(MAN_HTML)
8db9307c	16
30eba7bf	17	ARTICLES = howto-index
db9536c8	18	ARTICLES += everyday
4a5d6939	19	ARTICLES += git-tools
8db9307c	20	# with their own formatting rules.
471a5ce5	21	SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
530e741c JH	22	API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
	23	SP_ARTICLES += $(API_DOCS)
	24	SP_ARTICLES += technical/api-index
8db9307c JH	25
8db9307c JH	26	DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
789d5774	27
b2bf34d6	28	DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
2d76548b	29	DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
b2bf34d6 DG	30	DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
b2bf34d6 DG	31
d2b8593f	32	prefix?=$(HOME)
e14421b9	33	bindir?=$(prefix)/bin
5d6491c7	34	htmldir?=$(prefix)/share/doc/git-doc
a325a1a7	35	pdfdir?=$(prefix)/share/doc/git-doc
45fd8bd3	36	mandir?=$(prefix)/share/man
7b8cf0cf	37	man1dir=$(mandir)/man1
4392da4d	38	man5dir=$(mandir)/man5
7b8cf0cf	39	man7dir=$(mandir)/man7
a682ef9f	40	# DESTDIR=
87a81c83	41
1187d756	42	ASCIIDOC=asciidoc
26cfcfbf	43	ASCIIDOC_EXTRA =
c30e9485	44	MANPAGE_XSL = manpage-normal.xsl
5121a6d9	45	XMLTO_EXTRA =
d2b8593f	46	INSTALL?=install
4cb08df5	47	RM ?= rm -f
6538d1ef	48	DOC_REF = origin/man
6fe570de	49	HTML_REF = origin/html
87a81c83	50
4739809c DK	51	infodir?=$(prefix)/share/info
	52	MAKEINFO=makeinfo
	53	INSTALL_INFO=install-info
	54	DOCBOOK2X_TEXI=docbook2x-texi
a325a1a7	55	DBLATEX=dblatex
c680dd83 JH	56	ifndef PERL_PATH
	57	PERL_PATH = /usr/bin/perl
	58	endif
4739809c	59
95676853	60	-include ../config.mak.autogen
4fa96e15	61	-include ../config.mak
95676853	62
8fa2b45f CJ	63	#
	64	# For asciidoc ...
	65	# -7.1.2, no extra settings are needed.
	66	# 8.0-, set ASCIIDOC8.
	67	#
	68
	69	#
	70	# For docbook-xsl ...
	71	# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
2346431e CJ	72	# 1.69.0, no extra settings are needed?
	73	# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
	74	# 1.71.1, no extra settings are needed?
8fa2b45f CJ	75	# 1.72.0, set DOCBOOK_XSL_172.
	76	# 1.73.0-, set ASCIIDOC_NO_ROFF
	77	#
	78
	79	#
	80	# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
	81	# of 'the ".ft C" problem' in your generated manpages, and you
	82	# instead ended up with weird characters around callouts, try
	83	# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
	84	#
	85
7f55cf45 JF	86	ifdef ASCIIDOC8
	87	ASCIIDOC_EXTRA += -a asciidoc7compatible
	88	endif
	89	ifdef DOCBOOK_XSL_172
8fa2b45f	90	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
7a2078b4	91	MANPAGE_XSL = manpage-1.72.xsl
8fa2b45f CJ	92	else
	93	ifdef ASCIIDOC_NO_ROFF
	94	# docbook-xsl after 1.72 needs the regular XSL, but will not
	95	# pass-thru raw roff codes from asciidoc.conf, so turn them off.
	96	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
	97	endif
7f55cf45	98	endif
5121a6d9 CJ	99	ifdef MAN_BOLD_LITERAL
	100	XMLTO_EXTRA += -m manpage-bold-literal.xsl
	101	endif
2346431e CJ	102	ifdef DOCBOOK_SUPPRESS_SP
	103	XMLTO_EXTRA += -m manpage-suppress-sp.xsl
	104	endif
7f55cf45	105
ee7ec2f9 BW	106	SHELL_PATH ?= $(SHELL)
	107	# Shell quote;
	108	SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
	109
b2bf34d6 DG	110	#
	111	# Please note that there is a minor bug in asciidoc.
	112	# The version after 6.0.3 _will_ include the patch found here:
	113	# http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2
	114	#
	115	# Until that version is released you may have to apply the patch
	116	# yourself - yes, all 6 characters of it!
	117	#
	118
bb230097 CJ	119	QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
	120	QUIET_SUBDIR1 =
	121
	122	ifneq ($(findstring $(MAKEFLAGS),w),w)
	123	PRINT_DIR = --no-print-directory
	124	else # "make -w"
	125	NO_SUBDIR = :
	126	endif
	127
	128	ifneq ($(findstring $(MAKEFLAGS),s),s)
	129	ifndef V
	130	QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
	131	QUIET_XMLTO = @echo ' ' XMLTO $@;
	132	QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
	133	QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
	134	QUIET_DBLATEX = @echo ' ' DBLATEX $@;
	135	QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
	136	QUIET_GEN = @echo ' ' GEN $@;
	137	QUIET_STDERR = 2> /dev/null
	138	QUIET_SUBDIR0 = +@subdir=
	139	QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
	140	$(MAKE) $(PRINT_DIR) -C $$subdir
	141	export V
	142	endif
	143	endif
	144
b2bf34d6	145	all: html man
b790abb8 DG	146
	147	html: $(DOC_HTML)
	148
4392da4d	149	$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
b2bf34d6	150
4392da4d	151	man: man1 man5 man7
b2bf34d6	152	man1: $(DOC_MAN1)
4392da4d	153	man5: $(DOC_MAN5)
b2bf34d6	154	man7: $(DOC_MAN7)
b790abb8	155
5cefc33b	156	info: git.info gitman.info
4739809c	157
a325a1a7 MV	158	pdf: user-manual.pdf
a325a1a7 MV	159
b1a46b70 MH	160	install: install-man
	161
	162	install-man: man
41650765 RS	163	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
	164	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
	165	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
	166	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
	167	$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
	168	$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
87a81c83	169
4739809c	170	install-info: info
41650765	171	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
5cefc33b	172	$(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
4739809c DK	173	if test -r $(DESTDIR)$(infodir)/dir; then \
4739809c DK	174	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
5cefc33b	175	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
4739809c DK	176	else \
	177	echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
	178	fi
37465016	179
a325a1a7 MV	180	install-pdf: pdf
	181	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
	182	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
	183
5d6491c7	184	install-html: html
ee7ec2f9	185	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
5d6491c7	186
7b8a74f3	187	../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
bb230097	188	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
7b8a74f3 FL	189
	190	-include ../GIT-VERSION-FILE
	191
93d69d86 JL	192	#
	193	# Determine "include::" file references in asciidoc files.
	194	#
fb612d54	195	doc.dep : $(wildcard *.txt) build-docdep.perl
bb230097 CJ	196	$(QUIET_GEN)$(RM) $@+ $@ && \
bb230097 CJ	197	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
a5ae8e64	198	mv $@+ $@
93d69d86	199
a5ae8e64	200	-include doc.dep
37465016	201
72fe6a59 JH	202	cmds_txt = cmds-ancillaryinterrogators.txt \
	203	cmds-ancillarymanipulators.txt \
	204	cmds-mainporcelain.txt \
	205	cmds-plumbinginterrogators.txt \
	206	cmds-plumbingmanipulators.txt \
89bf2077 JH	207	cmds-synchingrepositories.txt \
	208	cmds-synchelpers.txt \
	209	cmds-purehelpers.txt \
	210	cmds-foreignscminterface.txt
72fe6a59	211
d7907392 JH	212	$(cmds_txt): cmd-list.made
d7907392 JH	213
79d30668	214	cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
bb230097 CJ	215	$(QUIET_GEN)$(RM) $@ && \
bb230097 CJ	216	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
d7907392	217	date >$@
b790abb8 DG	218
b790abb8 DG	219	clean:
4c785e50	220	$(RM) .xml .xml+ .html .html+ .1 .5 *.7
c6a5ad21	221	$(RM) .texi .texi+ *.texi++ git.info gitman.info
530e741c JH	222	$(RM) howto-index.txt howto/*.html doc.dep
530e741c JH	223	$(RM) technical/api-*.html technical/api-index.txt
4cb08df5	224	$(RM) $(cmds_txt) *.made
b790abb8	225
530e741c	226	$(MAN_HTML): %.html : %.txt
bb230097	227	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3	228	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
bb230097	229	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3	230	mv $@+ $@
b790abb8	231
4392da4d	232	%.1 %.5 %.7 : %.xml
bb230097	233	$(QUIET_XMLTO)$(RM) $@ && \
5121a6d9	234	xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
b790abb8 DG	235
b790abb8 DG	236	%.xml : %.txt
bb230097	237	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3	238	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
bb230097	239	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3	240	mv $@+ $@
3f971fc4	241
d19fbc3c	242	user-manual.xml: user-manual.txt user-manual.conf
26e47f25	243	$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book $<
d19fbc3c	244
530e741c JH	245	technical/api-index.txt: technical/api-index-skel.txt \
530e741c JH	246	technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
ee7ec2f9	247	$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
530e741c JH	248
530e741c JH	249	$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
bb230097	250	$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
530e741c JH	251	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
530e741c JH	252
1cffddd6	253	XSLT = docbook.xsl
0a3985dc	254	XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
1c95c565	255
d19fbc3c	256	user-manual.html: user-manual.xml
bb230097	257	$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
d19fbc3c	258
50b3555c	259	git.info: user-manual.texi
bb230097	260	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
5cefc33b	261
50b3555c	262	user-manual.texi: user-manual.xml
bb230097	263	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
c6a5ad21 CJ	264	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
	265	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
	266	rm $@++ && \
5cefc33b JH	267	mv $@+ $@
5cefc33b JH	268
a325a1a7	269	user-manual.pdf: user-manual.xml
bb230097 CJ	270	$(QUIET_DBLATEX)$(RM) $@+ $@ && \
bb230097 CJ	271	$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
a325a1a7 MV	272	mv $@+ $@
a325a1a7 MV	273
5cefc33b	274	gitman.texi: $(MAN_XML) cat-texi.perl
bb230097	275	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
8b30ad01	276	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
c6a5ad21 CJ	277	--to-stdout $(xml) &&) true) > $@++ && \
	278	$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
	279	rm $@++ && \
5cefc33b JH	280	mv $@+ $@
	281
	282	gitman.info: gitman.texi
bb230097	283	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
5cefc33b JH	284
5cefc33b JH	285	$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
bb230097 CJ	286	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
bb230097 CJ	287	$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
5cefc33b	288	mv $@+ $@
4739809c	289
e6fc2346	290	howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
bb230097	291	$(QUIET_GEN)$(RM) $@+ $@ && \
ee7ec2f9	292	'$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
e6fc2346 JH	293	mv $@+ $@
e6fc2346 JH	294
8db9307c	295	$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
26e47f25	296	$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
e6fc2346 JH	297
	298	WEBDOC_DEST = /pub/software/scm/git/docs
	299
8d0991d7	300	$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
bb230097	301	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
26e47f25	302	sed -e '1,/^$$/d' $< \| $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
8d0991d7 JH	303	mv $@+ $@
8d0991d7 JH	304
e6fc2346	305	install-webdoc : html
ee7ec2f9	306	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
6538d1ef	307
b1a46b70 MH	308	quick-install: quick-install-man
	309
	310	quick-install-man:
ee7ec2f9	311	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
7b8a74f3	312
6fe570de	313	quick-install-html:
ee7ec2f9	314	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
6fe570de	315
7b8a74f3	316	.PHONY: .FORCE-GIT-VERSION-FILE