[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 += gitsubmodules.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/hash-function-transition
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
DBLATEX_COMMON = -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty
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

ifdef USE_ASCIIDOCTOR
ASCIIDOC = asciidoctor
ASCIIDOC_CONF =
ASCIIDOC_HTML = xhtml5
ASCIIDOC_DOCBOOK = docbook45
ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
DBLATEX_COMMON =
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 book -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 $@+ $(DBLATEX_COMMON) $< && \
	mv $@+ $@

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