[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 += giteveryday.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 += everyday.html
OBSOLETE_HTML += git-remote-helpers.html
DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)

ARTICLES += howto-index
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/signature-format
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 =
ASCIIDOC_HTML = xhtml11
ASCIIDOC_DOCBOOK = docbook
ASCIIDOC_CONF = -f asciidoc.conf
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
		-agit_version=$(GIT_VERSION)
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
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
ifndef NO_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_LINT	= @echo '   ' LINT $@;
	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) $@+ $@ && \
	$(TXT_TO_HTML) -d manpage -o $@+ $< && \
	mv $@+ $@

$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(TXT_TO_HTML) -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) $@+ $@ && \
	$(TXT_TO_XML) -d manpage -o $@+ $< && \
	mv $@+ $@

user-manual.xml: user-manual.txt user-manual.conf
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(TXT_TO_XML) -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)$(TXT_TO_HTML) $*.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)$(TXT_TO_HTML) $*.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' $< | \
	$(TXT_TO_HTML) - >$@+ && \
	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

lint-docs::
	$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl

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