[thirdparty/git.git] / Documentation / Makefile

# Guard against environment variables
MAN1_TXT =
MAN5_TXT =
MAN7_TXT =
TECH_DOCS =
ARTICLES =
SP_ARTICLES =
OBSOLETE_HTML =

MAN1_TXT += $(filter-out \
		$(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
		$(wildcard git-*.txt))
MAN1_TXT += git.txt
MAN1_TXT += gitk.txt
MAN1_TXT += gitremote-helpers.txt
MAN1_TXT += gitweb.txt

MAN5_TXT += gitattributes.txt
MAN5_TXT += githooks.txt
MAN5_TXT += gitignore.txt
MAN5_TXT += gitmodules.txt
MAN5_TXT += gitrepository-layout.txt
MAN5_TXT += gitweb.conf.txt

MAN7_TXT += gitcli.txt
MAN7_TXT += gitcore-tutorial.txt
MAN7_TXT += gitcredentials.txt
MAN7_TXT += gitcvs-migration.txt
MAN7_TXT += gitdiffcore.txt
MAN7_TXT += gitglossary.txt
MAN7_TXT += gitnamespaces.txt
MAN7_TXT += gitrevisions.txt
MAN7_TXT += gittutorial-2.txt
MAN7_TXT += gittutorial.txt
MAN7_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))

OBSOLETE_HTML += git-remote-helpers.html
DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)

ARTICLES += howto-index
ARTICLES += everyday
ARTICLES += git-tools
ARTICLES += git-bisect-lk2009
# with their own formatting rules.
SP_ARTICLES += user-manual
SP_ARTICLES += howto/new-command
SP_ARTICLES += howto/revert-branch-rebase
SP_ARTICLES += howto/using-merge-subtree
SP_ARTICLES += howto/using-signed-tag-in-pull-request
SP_ARTICLES += howto/use-git-daemon
SP_ARTICLES += howto/update-hook-example
SP_ARTICLES += howto/setup-git-server-over-http
SP_ARTICLES += howto/separating-topic-branches
SP_ARTICLES += howto/revert-a-faulty-merge
SP_ARTICLES += howto/recover-corrupted-blob-object
SP_ARTICLES += howto/recover-corrupted-object-harder
SP_ARTICLES += howto/rebuild-from-update-hook
SP_ARTICLES += howto/rebase-from-internal-branch
SP_ARTICLES += howto/keep-canonical-history-correct
SP_ARTICLES += howto/maintain-git
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
SP_ARTICLES += $(API_DOCS)

TECH_DOCS += technical/http-protocol
TECH_DOCS += technical/index-format
TECH_DOCS += technical/pack-format
TECH_DOCS += technical/pack-heuristics
TECH_DOCS += technical/pack-protocol
TECH_DOCS += technical/protocol-capabilities
TECH_DOCS += technical/protocol-common
TECH_DOCS += technical/racy-git
TECH_DOCS += technical/send-pack-pipeline
TECH_DOCS += technical/shallow
TECH_DOCS += technical/trivial-merge
SP_ARTICLES += $(TECH_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
infodir ?= $(prefix)/share/info
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 = xmlto
XMLTO_EXTRA =
INSTALL ?= install
RM ?= rm -f
MAN_REPO = ../../git-manpages
HTML_REPO = ../../git-htmldocs

MAKEINFO = makeinfo
INSTALL_INFO = install-info
DOCBOOK2X_TEXI = docbook2x-texi
DBLATEX = dblatex
ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
ifndef PERL_PATH
	PERL_PATH = /usr/bin/perl
endif

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

#
# For docbook-xsl ...
#	-1.68.1,	no extra settings are needed?
#	1.69.0,		set ASCIIDOC_ROFF?
#	1.69.1-1.71.0,	set DOCBOOK_SUPPRESS_SP?
#	1.71.1,		set ASCIIDOC_ROFF?
#	1.72.0,		set DOCBOOK_XSL_172.
#	1.73.0-,	no extra settings are needed
#

ifdef DOCBOOK_XSL_172
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
MANPAGE_XSL = manpage-1.72.xsl
else
	ifndef ASCIIDOC_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

# Newer DocBook stylesheet emits warning cruft in the output when
# this is not set, and if set it shows an absolute link.  Older
# stylesheets simply ignore this parameter.
#
# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
# or similar.
ifndef MAN_BASE_URL
MAN_BASE_URL = file://$(htmldir)/
endif
XMLTO_EXTRA += -m manpage-base-url.xsl

# If your target system uses GNU groff, it may try to render
# apostrophes as a "pretty" apostrophe using unicode.  This breaks
# cut&paste, so you should set GNU_ROFF to force them to be ASCII
# apostrophes.  Unfortunately does not work with non-GNU roff.
ifdef GNU_ROFF
XMLTO_EXTRA += -m manpage-quote-apos.xsl
endif

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

ifdef DEFAULT_PAGER
DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
endif

ifdef DEFAULT_EDITOR
DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
endif

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)

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
	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE

-include ../GIT-VERSION-FILE

#
# Determine "include::" file references in asciidoc files.
#
docdep_prereqs = \
	mergetools-list.made $(mergetools_txt) \
	cmd-list.made $(cmds_txt)

doc.dep : $(docdep_prereqs) $(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 >$@

mergetools_txt = mergetools-diff.txt mergetools-merge.txt

$(mergetools_txt): mergetools-list.made

mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
	$(QUIET_GEN)$(RM) $@ && \
	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
		. ../git-mergetool--lib.sh && \
		show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
		. ../git-mergetool--lib.sh && \
		show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
	date >$@

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

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

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

manpage-base-url.xsl: manpage-base-url.xsl.in
	sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@

%.1 %.5 %.7 : %.xml manpage-base-url.xsl
	$(QUIET_XMLTO)$(RM) $@ && \
	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<

%.xml : %.txt asciidoc.conf
	$(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)$(RM) $@+ $@ && \
	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
	mv $@+ $@

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

technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
	$(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 $(XSLT)
	$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
	xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
	mv $@+ $@

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 $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/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 $(sort $(wildcard howto/*.txt)) >$@+ && \
	mv $@+ $@

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

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

howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
$(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)

# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
# next to the 'git' repository itself for the following to work.

quick-install: quick-install-man

require-manrepo::
	@if test ! -d $(MAN_REPO); \
	then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi

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

require-htmlrepo::
	@if test ! -d $(HTML_REPO); \
	then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi

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

print-man1:
	@for i in $(MAN1_TXT); do echo $$i; done

.PHONY: FORCE
Commit	Line	Data
a617578d JK	1	# Guard against environment variables
	2	MAN1_TXT =
	3	MAN5_TXT =
	4	MAN7_TXT =
43cc5ce9 JH	5	TECH_DOCS =
	6	ARTICLES =
	7	SP_ARTICLES =
5a568ea0	8	OBSOLETE_HTML =
a617578d JK	9
	10	MAN1_TXT += $(filter-out \
	11	$(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
	12	$(wildcard git-*.txt))
	13	MAN1_TXT += git.txt
	14	MAN1_TXT += gitk.txt
b9a5f681	15	MAN1_TXT += gitremote-helpers.txt
a617578d JK	16	MAN1_TXT += gitweb.txt
	17
	18	MAN5_TXT += gitattributes.txt
	19	MAN5_TXT += githooks.txt
	20	MAN5_TXT += gitignore.txt
	21	MAN5_TXT += gitmodules.txt
	22	MAN5_TXT += gitrepository-layout.txt
	23	MAN5_TXT += gitweb.conf.txt
	24
	25	MAN7_TXT += gitcli.txt
	26	MAN7_TXT += gitcore-tutorial.txt
a6fc9fd3	27	MAN7_TXT += gitcredentials.txt
a617578d JK	28	MAN7_TXT += gitcvs-migration.txt
	29	MAN7_TXT += gitdiffcore.txt
	30	MAN7_TXT += gitglossary.txt
	31	MAN7_TXT += gitnamespaces.txt
	32	MAN7_TXT += gitrevisions.txt
	33	MAN7_TXT += gittutorial-2.txt
	34	MAN7_TXT += gittutorial.txt
	35	MAN7_TXT += gitworkflows.txt
b790abb8	36
5cefc33b	37	MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
692cfd6b JK	38	MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
692cfd6b JK	39	MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
5cefc33b	40
5a568ea0	41	OBSOLETE_HTML += git-remote-helpers.html
692cfd6b	42	DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
8db9307c	43
43cc5ce9	44	ARTICLES += howto-index
db9536c8	45	ARTICLES += everyday
4a5d6939	46	ARTICLES += git-tools
69a9cd31	47	ARTICLES += git-bisect-lk2009
8db9307c	48	# with their own formatting rules.
43cc5ce9	49	SP_ARTICLES += user-manual
81670e9b	50	SP_ARTICLES += howto/new-command
11b17afc JH	51	SP_ARTICLES += howto/revert-branch-rebase
	52	SP_ARTICLES += howto/using-merge-subtree
	53	SP_ARTICLES += howto/using-signed-tag-in-pull-request
5e00439f TA	54	SP_ARTICLES += howto/use-git-daemon
	55	SP_ARTICLES += howto/update-hook-example
	56	SP_ARTICLES += howto/setup-git-server-over-http
	57	SP_ARTICLES += howto/separating-topic-branches
	58	SP_ARTICLES += howto/revert-a-faulty-merge
	59	SP_ARTICLES += howto/recover-corrupted-blob-object
41dfbb2d	60	SP_ARTICLES += howto/recover-corrupted-object-harder
5e00439f	61	SP_ARTICLES += howto/rebuild-from-update-hook
5e00439f	62	SP_ARTICLES += howto/rebase-from-internal-branch
0678b649	63	SP_ARTICLES += howto/keep-canonical-history-correct
5e00439f	64	SP_ARTICLES += howto/maintain-git
530e741c JH	65	API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
530e741c JH	66	SP_ARTICLES += $(API_DOCS)
5e00439f	67
43cc5ce9	68	TECH_DOCS += technical/http-protocol
586aa786	69	TECH_DOCS += technical/index-format
5e00439f TA	70	TECH_DOCS += technical/pack-format
	71	TECH_DOCS += technical/pack-heuristics
	72	TECH_DOCS += technical/pack-protocol
	73	TECH_DOCS += technical/protocol-capabilities
	74	TECH_DOCS += technical/protocol-common
	75	TECH_DOCS += technical/racy-git
	76	TECH_DOCS += technical/send-pack-pipeline
	77	TECH_DOCS += technical/shallow
	78	TECH_DOCS += technical/trivial-merge
	79	SP_ARTICLES += $(TECH_DOCS)
530e741c	80	SP_ARTICLES += technical/api-index
8db9307c JH	81
8db9307c JH	82	DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
789d5774	83
692cfd6b JK	84	DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
	85	DOC_MAN5 = $(patsubst %.txt,%.5,$(MAN5_TXT))
	86	DOC_MAN7 = $(patsubst %.txt,%.7,$(MAN7_TXT))
b2bf34d6	87
692cfd6b JK	88	prefix ?= $(HOME)
	89	bindir ?= $(prefix)/bin
	90	htmldir ?= $(prefix)/share/doc/git-doc
e21db2c6	91	infodir ?= $(prefix)/share/info
692cfd6b JK	92	pdfdir ?= $(prefix)/share/doc/git-doc
	93	mandir ?= $(prefix)/share/man
	94	man1dir = $(mandir)/man1
	95	man5dir = $(mandir)/man5
	96	man7dir = $(mandir)/man7
	97	# DESTDIR =
87a81c83	98
dd4f3075	99	ASCIIDOC = asciidoc
26cfcfbf	100	ASCIIDOC_EXTRA =
c30e9485	101	MANPAGE_XSL = manpage-normal.xsl
dd4f3075	102	XMLTO = xmlto
5121a6d9	103	XMLTO_EXTRA =
692cfd6b	104	INSTALL ?= install
4cb08df5	105	RM ?= rm -f
fcbebfdd JH	106	MAN_REPO = ../../git-manpages
fcbebfdd JH	107	HTML_REPO = ../../git-htmldocs
87a81c83	108
692cfd6b JK	109	MAKEINFO = makeinfo
	110	INSTALL_INFO = install-info
	111	DOCBOOK2X_TEXI = docbook2x-texi
	112	DBLATEX = dblatex
0079d6eb	113	ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
c680dd83 JH	114	ifndef PERL_PATH
	115	PERL_PATH = /usr/bin/perl
	116	endif
4739809c	117
95676853	118	-include ../config.mak.autogen
4fa96e15	119	-include ../config.mak
95676853	120
8fa2b45f CJ	121	#
8fa2b45f CJ	122	# For docbook-xsl ...
79c461d5 JK	123	# -1.68.1, no extra settings are needed?
79c461d5 JK	124	# 1.69.0, set ASCIIDOC_ROFF?
2346431e	125	# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
79c461d5	126	# 1.71.1, set ASCIIDOC_ROFF?
8fa2b45f	127	# 1.72.0, set DOCBOOK_XSL_172.
79c461d5	128	# 1.73.0-, no extra settings are needed
8fa2b45f CJ	129	#
8fa2b45f CJ	130
7f55cf45	131	ifdef DOCBOOK_XSL_172
8fa2b45f	132	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
7a2078b4	133	MANPAGE_XSL = manpage-1.72.xsl
8fa2b45f	134	else
79c461d5	135	ifndef ASCIIDOC_ROFF
8fa2b45f CJ	136	# docbook-xsl after 1.72 needs the regular XSL, but will not
	137	# pass-thru raw roff codes from asciidoc.conf, so turn them off.
	138	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
	139	endif
7f55cf45	140	endif
5121a6d9 CJ	141	ifdef MAN_BOLD_LITERAL
	142	XMLTO_EXTRA += -m manpage-bold-literal.xsl
	143	endif
2346431e CJ	144	ifdef DOCBOOK_SUPPRESS_SP
	145	XMLTO_EXTRA += -m manpage-suppress-sp.xsl
	146	endif
7f55cf45	147
8dd35c71	148	# Newer DocBook stylesheet emits warning cruft in the output when
50d9bbba TZ	149	# this is not set, and if set it shows an absolute link. Older
50d9bbba TZ	150	# stylesheets simply ignore this parameter.
59a0a0bd	151	#
50d9bbba TZ	152	# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
	153	# or similar.
	154	ifndef MAN_BASE_URL
	155	MAN_BASE_URL = file://$(htmldir)/
59a0a0bd	156	endif
50d9bbba	157	XMLTO_EXTRA += -m manpage-base-url.xsl
a479a564	158
204d363f TR	159	# If your target system uses GNU groff, it may try to render
	160	# apostrophes as a "pretty" apostrophe using unicode. This breaks
	161	# cut&paste, so you should set GNU_ROFF to force them to be ASCII
	162	# apostrophes. Unfortunately does not work with non-GNU roff.
	163	ifdef GNU_ROFF
	164	XMLTO_EXTRA += -m manpage-quote-apos.xsl
	165	endif
	166
ee7ec2f9 BW	167	SHELL_PATH ?= $(SHELL)
	168	# Shell quote;
	169	SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
	170
5b58619a JN	171	ifdef DEFAULT_PAGER
	172	DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
	173	ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
	174	endif
	175
	176	ifdef DEFAULT_EDITOR
	177	DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
	178	ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
	179	endif
	180
bb230097 CJ	181	QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
	182	QUIET_SUBDIR1 =
	183
	184	ifneq ($(findstring $(MAKEFLAGS),w),w)
	185	PRINT_DIR = --no-print-directory
	186	else # "make -w"
	187	NO_SUBDIR = :
	188	endif
	189
	190	ifneq ($(findstring $(MAKEFLAGS),s),s)
	191	ifndef V
	192	QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
	193	QUIET_XMLTO = @echo ' ' XMLTO $@;
	194	QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
	195	QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
	196	QUIET_DBLATEX = @echo ' ' DBLATEX $@;
	197	QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
	198	QUIET_GEN = @echo ' ' GEN $@;
	199	QUIET_STDERR = 2> /dev/null
	200	QUIET_SUBDIR0 = +@subdir=
	201	QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
	202	$(MAKE) $(PRINT_DIR) -C $$subdir
	203	export V
	204	endif
	205	endif
	206
b2bf34d6	207	all: html man
b790abb8 DG	208
	209	html: $(DOC_HTML)
	210
4392da4d	211	man: man1 man5 man7
b2bf34d6	212	man1: $(DOC_MAN1)
4392da4d	213	man5: $(DOC_MAN5)
b2bf34d6	214	man7: $(DOC_MAN7)
b790abb8	215
5cefc33b	216	info: git.info gitman.info
4739809c	217
a325a1a7 MV	218	pdf: user-manual.pdf
a325a1a7 MV	219
b1a46b70 MH	220	install: install-man
	221
	222	install-man: man
41650765 RS	223	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
	224	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
	225	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
	226	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
	227	$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
	228	$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
87a81c83	229
4739809c	230	install-info: info
41650765	231	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
5cefc33b	232	$(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
4739809c DK	233	if test -r $(DESTDIR)$(infodir)/dir; then \
4739809c DK	234	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
5cefc33b	235	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
4739809c DK	236	else \
	237	echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
	238	fi
37465016	239
a325a1a7 MV	240	install-pdf: pdf
	241	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
	242	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
	243
5d6491c7	244	install-html: html
ee7ec2f9	245	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
5d6491c7	246
13fca9f3	247	../GIT-VERSION-FILE: FORCE
bb230097	248	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
7b8a74f3 FL	249
	250	-include ../GIT-VERSION-FILE
	251
93d69d86 JL	252	#
	253	# Determine "include::" file references in asciidoc files.
	254	#
f35ec546 DA	255	docdep_prereqs = \
	256	mergetools-list.made $(mergetools_txt) \
	257	cmd-list.made $(cmds_txt)
	258
	259	doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
bb230097 CJ	260	$(QUIET_GEN)$(RM) $@+ $@ && \
bb230097 CJ	261	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
a5ae8e64	262	mv $@+ $@
93d69d86	263
a5ae8e64	264	-include doc.dep
37465016	265
72fe6a59 JH	266	cmds_txt = cmds-ancillaryinterrogators.txt \
	267	cmds-ancillarymanipulators.txt \
	268	cmds-mainporcelain.txt \
	269	cmds-plumbinginterrogators.txt \
	270	cmds-plumbingmanipulators.txt \
89bf2077 JH	271	cmds-synchingrepositories.txt \
	272	cmds-synchelpers.txt \
	273	cmds-purehelpers.txt \
	274	cmds-foreignscminterface.txt
72fe6a59	275
d7907392 JH	276	$(cmds_txt): cmd-list.made
d7907392 JH	277
79d30668	278	cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
bb230097 CJ	279	$(QUIET_GEN)$(RM) $@ && \
bb230097 CJ	280	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
d7907392	281	date >$@
b790abb8	282
f35ec546 DA	283	mergetools_txt = mergetools-diff.txt mergetools-merge.txt
	284
	285	$(mergetools_txt): mergetools-list.made
	286
	287	mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
	288	$(QUIET_GEN)$(RM) $@ && \
	289	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
	290	. ../git-mergetool--lib.sh && \
	291	show_tool_names can_diff "* " \|\| :' >mergetools-diff.txt && \
	292	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
	293	. ../git-mergetool--lib.sh && \
	294	show_tool_names can_merge "* " \|\| :' >mergetools-merge.txt && \
	295	date >$@
	296
b790abb8	297	clean:
4c785e50	298	$(RM) .xml .xml+ .html .html+ .1 .5 *.7
c6a5ad21	299	$(RM) .texi .texi+ *.texi++ git.info gitman.info
ae8044a2	300	$(RM) *.pdf
530e741c	301	$(RM) howto-index.txt howto/*.html doc.dep
5e00439f	302	$(RM) technical/*.html technical/api-index.txt
f35ec546	303	$(RM) $(cmds_txt) $(mergetools_txt) *.made
50d9bbba	304	$(RM) manpage-base-url.xsl
b790abb8	305
fdb04244	306	$(MAN_HTML): %.html : %.txt asciidoc.conf
bb230097	307	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3	308	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
bb230097	309	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3	310	mv $@+ $@
b790abb8	311
bd4a3d61 JK	312	$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
	313	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	314	$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
	315	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
	316	mv $@+ $@
	317
50d9bbba TZ	318	manpage-base-url.xsl: manpage-base-url.xsl.in
	319	sed "s\|@@MAN_BASE_URL@@\|$(MAN_BASE_URL)\|" $< > $@
	320
	321	%.1 %.5 %.7 : %.xml manpage-base-url.xsl
bb230097	322	$(QUIET_XMLTO)$(RM) $@ && \
dd4f3075	323	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
b790abb8	324
fdb04244	325	%.xml : %.txt asciidoc.conf
bb230097	326	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
7b8a74f3	327	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
bb230097	328	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
7b8a74f3	329	mv $@+ $@
3f971fc4	330
d19fbc3c	331	user-manual.xml: user-manual.txt user-manual.conf
f9dae0d3	332	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
145e073b	333	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
f9dae0d3	334	mv $@+ $@
d19fbc3c	335
530e741c JH	336	technical/api-index.txt: technical/api-index-skel.txt \
530e741c JH	337	technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
ee7ec2f9	338	$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
530e741c	339
fe77b416	340	technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
fdb04244	341	$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf
bb230097	342	$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
530e741c JH	343	$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
530e741c JH	344
1cffddd6	345	XSLT = docbook.xsl
0a3985dc	346	XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
1c95c565	347
f2aff316	348	user-manual.html: user-manual.xml $(XSLT)
f9dae0d3 JN	349	$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
	350	xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
	351	mv $@+ $@
d19fbc3c	352
50b3555c	353	git.info: user-manual.texi
bb230097	354	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
5cefc33b	355
50b3555c	356	user-manual.texi: user-manual.xml
bb230097	357	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
c6a5ad21 CJ	358	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
	359	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
	360	rm $@++ && \
5cefc33b JH	361	mv $@+ $@
5cefc33b JH	362
a325a1a7	363	user-manual.pdf: user-manual.xml
bb230097	364	$(QUIET_DBLATEX)$(RM) $@+ $@ && \
0079d6eb	365	$(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \
a325a1a7 MV	366	mv $@+ $@
a325a1a7 MV	367
5cefc33b	368	gitman.texi: $(MAN_XML) cat-texi.perl
bb230097	369	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
8b30ad01	370	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
c6a5ad21 CJ	371	--to-stdout $(xml) &&) true) > $@++ && \
	372	$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
	373	rm $@++ && \
5cefc33b JH	374	mv $@+ $@
	375
	376	gitman.info: gitman.texi
bb230097	377	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
5cefc33b JH	378
5cefc33b JH	379	$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
bb230097 CJ	380	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
bb230097 CJ	381	$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
5cefc33b	382	mv $@+ $@
4739809c	383
e6fc2346	384	howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
bb230097	385	$(QUIET_GEN)$(RM) $@+ $@ && \
854dfda8	386	'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
e6fc2346 JH	387	mv $@+ $@
e6fc2346 JH	388
8db9307c	389	$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
26e47f25	390	$(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 $*.txt
e6fc2346 JH	391
	392	WEBDOC_DEST = /pub/software/scm/git/docs
	393
fe77b416	394	howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
8d0991d7	395	$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
bb230097	396	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
26e47f25	397	sed -e '1,/^$$/d' $< \| $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
8d0991d7 JH	398	mv $@+ $@
8d0991d7 JH	399
e6fc2346	400	install-webdoc : html
ee7ec2f9	401	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
6538d1ef	402
2de9b711 TA	403	# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
2de9b711 TA	404	# next to the 'git' repository itself for the following to work.
fcbebfdd	405
b1a46b70 MH	406	quick-install: quick-install-man
b1a46b70 MH	407
fcbebfdd JH	408	require-manrepo::
	409	@if test ! -d $(MAN_REPO); \
	410	then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
	411
	412	quick-install-man: require-manrepo
	413	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir)
	414
	415	require-htmlrepo::
	416	@if test ! -d $(HTML_REPO); \
	417	then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
7b8a74f3	418
fcbebfdd JH	419	quick-install-html: require-htmlrepo
fcbebfdd JH	420	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
6fe570de	421
5fafce0b JK	422	print-man1:
	423	@for i in $(MAN1_TXT); do echo $$i; done
	424
13fca9f3	425	.PHONY: FORCE