[thirdparty/git.git] / Documentation / Makefile

# Guard against environment variables
MAN1_TXT =
MAN5_TXT =
MAN7_TXT =

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