[thirdparty/git.git] / Documentation / Makefile

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

-include GIT-EXCLUDED-PROGRAMS

MAN1_TXT += $(filter-out \
		$(patsubst %,%.txt,$(EXCLUDED_PROGRAMS)) \
		$(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
		$(wildcard git-*.txt))
MAN1_TXT += git.txt
MAN1_TXT += gitk.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 += gitremote-helpers.txt
MAN7_TXT += gitrevisions.txt
MAN7_TXT += gitsubmodules.txt
MAN7_TXT += gittutorial-2.txt
MAN7_TXT += gittutorial.txt
MAN7_TXT += gitworkflows.txt

ifdef MAN_FILTER
MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
else
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_FILTER = $(MAN_TXT)
endif

MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
GIT_MAN_REF = master

OBSOLETE_HTML += everyday.html
OBSOLETE_HTML += git-remote-helpers.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 += MyFirstContribution
TECH_DOCS += MyFirstObjectWalk
TECH_DOCS += SubmittingPatches
TECH_DOCS += technical/hash-function-transition
TECH_DOCS += technical/http-protocol
TECH_DOCS += technical/index-format
TECH_DOCS += technical/long-running-process-protocol
TECH_DOCS += technical/multi-pack-index
TECH_DOCS += technical/pack-format
TECH_DOCS += technical/pack-heuristics
TECH_DOCS += technical/pack-protocol
TECH_DOCS += technical/partial-clone
TECH_DOCS += technical/protocol-capabilities
TECH_DOCS += technical/protocol-common
TECH_DOCS += technical/protocol-v2
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

ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML))

DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT)))
DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT)))
DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(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) \
		-amanversion=$(GIT_VERSION) \
		-amanmanual='Git Manual' -amansource='Git'
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 = docbook5
ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
DBLATEX_COMMON =
XMLTO_EXTRA += --skip-validation
XMLTO_EXTRA += -x manpage.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) $(wildcard config/*.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 >$@

TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))

GIT-ASCIIDOCFLAGS: FORCE
	@FLAGS='$(TRACK_ASCIIDOCFLAGS)'; \
	    if test x"$$FLAGS" != x"`cat GIT-ASCIIDOCFLAGS 2>/dev/null`" ; then \
		echo >&2 "    * new asciidoc flags"; \
		echo "$$FLAGS" >GIT-ASCIIDOCFLAGS; \
            fi

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) SubmittingPatches.txt
	$(RM) $(cmds_txt) $(mergetools_txt) *.made
	$(RM) manpage-base-url.xsl
	$(RM) GIT-ASCIIDOCFLAGS

$(MAN_HTML): %.html : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(TXT_TO_HTML) -d manpage -o $@+ $< && \
	mv $@+ $@

$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(TXT_TO_HTML) -o $@+ $< && \
	mv $@+ $@

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

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

%.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	$(TXT_TO_XML) -d manpage -o $@+ $< && \
	mv $@+ $@

user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	$(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 GIT-ASCIIDOCFLAGS
	$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt

SubmittingPatches.txt: SubmittingPatches
	$(QUIET_GEN) cp $< $@

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 GIT-ASCIIDOCFLAGS
	$(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) $(GIT_MAN_REF)

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) $(GIT_MAN_REF)

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

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

ifeq ($(wildcard po/Makefile),po/Makefile)
doc-l10n install-l10n::
	$(MAKE) -C po $@
endif

.PHONY: FORCE
Commit	Line	Data
	1	# Guard against environment variables
	2	MAN1_TXT =
	3	MAN5_TXT =
	4	MAN7_TXT =
	5	TECH_DOCS =
	6	ARTICLES =
	7	SP_ARTICLES =
	8	OBSOLETE_HTML =
	9
	10	-include GIT-EXCLUDED-PROGRAMS
	11
	12	MAN1_TXT += $(filter-out \
	13	$(patsubst %,%.txt,$(EXCLUDED_PROGRAMS)) \
	14	$(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
	15	$(wildcard git-*.txt))
	16	MAN1_TXT += git.txt
	17	MAN1_TXT += gitk.txt
	18	MAN1_TXT += gitweb.txt
	19
	20	MAN5_TXT += gitattributes.txt
	21	MAN5_TXT += githooks.txt
	22	MAN5_TXT += gitignore.txt
	23	MAN5_TXT += gitmodules.txt
	24	MAN5_TXT += gitrepository-layout.txt
	25	MAN5_TXT += gitweb.conf.txt
	26
	27	MAN7_TXT += gitcli.txt
	28	MAN7_TXT += gitcore-tutorial.txt
	29	MAN7_TXT += gitcredentials.txt
	30	MAN7_TXT += gitcvs-migration.txt
	31	MAN7_TXT += gitdiffcore.txt
	32	MAN7_TXT += giteveryday.txt
	33	MAN7_TXT += gitglossary.txt
	34	MAN7_TXT += gitnamespaces.txt
	35	MAN7_TXT += gitremote-helpers.txt
	36	MAN7_TXT += gitrevisions.txt
	37	MAN7_TXT += gitsubmodules.txt
	38	MAN7_TXT += gittutorial-2.txt
	39	MAN7_TXT += gittutorial.txt
	40	MAN7_TXT += gitworkflows.txt
	41
	42	ifdef MAN_FILTER
	43	MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
	44	else
	45	MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
	46	MAN_FILTER = $(MAN_TXT)
	47	endif
	48
	49	MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
	50	MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
	51	GIT_MAN_REF = master
	52
	53	OBSOLETE_HTML += everyday.html
	54	OBSOLETE_HTML += git-remote-helpers.html
	55
	56	ARTICLES += howto-index
	57	ARTICLES += git-tools
	58	ARTICLES += git-bisect-lk2009
	59	# with their own formatting rules.
	60	SP_ARTICLES += user-manual
	61	SP_ARTICLES += howto/new-command
	62	SP_ARTICLES += howto/revert-branch-rebase
	63	SP_ARTICLES += howto/using-merge-subtree
	64	SP_ARTICLES += howto/using-signed-tag-in-pull-request
	65	SP_ARTICLES += howto/use-git-daemon
	66	SP_ARTICLES += howto/update-hook-example
	67	SP_ARTICLES += howto/setup-git-server-over-http
	68	SP_ARTICLES += howto/separating-topic-branches
	69	SP_ARTICLES += howto/revert-a-faulty-merge
	70	SP_ARTICLES += howto/recover-corrupted-blob-object
	71	SP_ARTICLES += howto/recover-corrupted-object-harder
	72	SP_ARTICLES += howto/rebuild-from-update-hook
	73	SP_ARTICLES += howto/rebase-from-internal-branch
	74	SP_ARTICLES += howto/keep-canonical-history-correct
	75	SP_ARTICLES += howto/maintain-git
	76	API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
	77	SP_ARTICLES += $(API_DOCS)
	78
	79	TECH_DOCS += MyFirstContribution
	80	TECH_DOCS += MyFirstObjectWalk
	81	TECH_DOCS += SubmittingPatches
	82	TECH_DOCS += technical/hash-function-transition
	83	TECH_DOCS += technical/http-protocol
	84	TECH_DOCS += technical/index-format
	85	TECH_DOCS += technical/long-running-process-protocol
	86	TECH_DOCS += technical/multi-pack-index
	87	TECH_DOCS += technical/pack-format
	88	TECH_DOCS += technical/pack-heuristics
	89	TECH_DOCS += technical/pack-protocol
	90	TECH_DOCS += technical/partial-clone
	91	TECH_DOCS += technical/protocol-capabilities
	92	TECH_DOCS += technical/protocol-common
	93	TECH_DOCS += technical/protocol-v2
	94	TECH_DOCS += technical/racy-git
	95	TECH_DOCS += technical/send-pack-pipeline
	96	TECH_DOCS += technical/shallow
	97	TECH_DOCS += technical/signature-format
	98	TECH_DOCS += technical/trivial-merge
	99	SP_ARTICLES += $(TECH_DOCS)
	100	SP_ARTICLES += technical/api-index
	101
	102	ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
	103	HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
	104	DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML))
	105
	106	DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT)))
	107	DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT)))
	108	DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT)))
	109
	110	prefix ?= $(HOME)
	111	bindir ?= $(prefix)/bin
	112	htmldir ?= $(prefix)/share/doc/git-doc
	113	infodir ?= $(prefix)/share/info
	114	pdfdir ?= $(prefix)/share/doc/git-doc
	115	mandir ?= $(prefix)/share/man
	116	man1dir = $(mandir)/man1
	117	man5dir = $(mandir)/man5
	118	man7dir = $(mandir)/man7
	119	# DESTDIR =
	120
	121	ASCIIDOC = asciidoc
	122	ASCIIDOC_EXTRA =
	123	ASCIIDOC_HTML = xhtml11
	124	ASCIIDOC_DOCBOOK = docbook
	125	ASCIIDOC_CONF = -f asciidoc.conf
	126	ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
	127	-amanversion=$(GIT_VERSION) \
	128	-amanmanual='Git Manual' -amansource='Git'
	129	TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
	130	TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
	131	MANPAGE_XSL = manpage-normal.xsl
	132	XMLTO = xmlto
	133	XMLTO_EXTRA =
	134	INSTALL ?= install
	135	RM ?= rm -f
	136	MAN_REPO = ../../git-manpages
	137	HTML_REPO = ../../git-htmldocs
	138
	139	MAKEINFO = makeinfo
	140	INSTALL_INFO = install-info
	141	DOCBOOK2X_TEXI = docbook2x-texi
	142	DBLATEX = dblatex
	143	ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex
	144	DBLATEX_COMMON = -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty
	145	ifndef PERL_PATH
	146	PERL_PATH = /usr/bin/perl
	147	endif
	148
	149	-include ../config.mak.autogen
	150	-include ../config.mak
	151
	152	#
	153	# For docbook-xsl ...
	154	# -1.68.1, no extra settings are needed?
	155	# 1.69.0, set ASCIIDOC_ROFF?
	156	# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
	157	# 1.71.1, set ASCIIDOC_ROFF?
	158	# 1.72.0, set DOCBOOK_XSL_172.
	159	# 1.73.0-, no extra settings are needed
	160	#
	161
	162	ifdef DOCBOOK_XSL_172
	163	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
	164	MANPAGE_XSL = manpage-1.72.xsl
	165	else
	166	ifndef ASCIIDOC_ROFF
	167	# docbook-xsl after 1.72 needs the regular XSL, but will not
	168	# pass-thru raw roff codes from asciidoc.conf, so turn them off.
	169	ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
	170	endif
	171	endif
	172	ifndef NO_MAN_BOLD_LITERAL
	173	XMLTO_EXTRA += -m manpage-bold-literal.xsl
	174	endif
	175	ifdef DOCBOOK_SUPPRESS_SP
	176	XMLTO_EXTRA += -m manpage-suppress-sp.xsl
	177	endif
	178
	179	# Newer DocBook stylesheet emits warning cruft in the output when
	180	# this is not set, and if set it shows an absolute link. Older
	181	# stylesheets simply ignore this parameter.
	182	#
	183	# Distros may want to use MAN_BASE_URL=file:///path/to/git/docs/
	184	# or similar.
	185	ifndef MAN_BASE_URL
	186	MAN_BASE_URL = file://$(htmldir)/
	187	endif
	188	XMLTO_EXTRA += -m manpage-base-url.xsl
	189
	190	# If your target system uses GNU groff, it may try to render
	191	# apostrophes as a "pretty" apostrophe using unicode. This breaks
	192	# cut&paste, so you should set GNU_ROFF to force them to be ASCII
	193	# apostrophes. Unfortunately does not work with non-GNU roff.
	194	ifdef GNU_ROFF
	195	XMLTO_EXTRA += -m manpage-quote-apos.xsl
	196	endif
	197
	198	ifdef USE_ASCIIDOCTOR
	199	ASCIIDOC = asciidoctor
	200	ASCIIDOC_CONF =
	201	ASCIIDOC_HTML = xhtml5
	202	ASCIIDOC_DOCBOOK = docbook5
	203	ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
	204	ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
	205	ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
	206	DBLATEX_COMMON =
	207	XMLTO_EXTRA += --skip-validation
	208	XMLTO_EXTRA += -x manpage.xsl
	209	endif
	210
	211	SHELL_PATH ?= $(SHELL)
	212	# Shell quote;
	213	SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
	214
	215	ifdef DEFAULT_PAGER
	216	DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER))
	217	ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)'
	218	endif
	219
	220	ifdef DEFAULT_EDITOR
	221	DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR))
	222	ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)'
	223	endif
	224
	225	QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
	226	QUIET_SUBDIR1 =
	227
	228	ifneq ($(findstring $(MAKEFLAGS),w),w)
	229	PRINT_DIR = --no-print-directory
	230	else # "make -w"
	231	NO_SUBDIR = :
	232	endif
	233
	234	ifneq ($(findstring $(MAKEFLAGS),s),s)
	235	ifndef V
	236	QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
	237	QUIET_XMLTO = @echo ' ' XMLTO $@;
	238	QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
	239	QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
	240	QUIET_DBLATEX = @echo ' ' DBLATEX $@;
	241	QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
	242	QUIET_GEN = @echo ' ' GEN $@;
	243	QUIET_LINT = @echo ' ' LINT $@;
	244	QUIET_STDERR = 2> /dev/null
	245	QUIET_SUBDIR0 = +@subdir=
	246	QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
	247	$(MAKE) $(PRINT_DIR) -C $$subdir
	248	export V
	249	endif
	250	endif
	251
	252	all: html man
	253
	254	html: $(DOC_HTML)
	255
	256	man: man1 man5 man7
	257	man1: $(DOC_MAN1)
	258	man5: $(DOC_MAN5)
	259	man7: $(DOC_MAN7)
	260
	261	info: git.info gitman.info
	262
	263	pdf: user-manual.pdf
	264
	265	install: install-man
	266
	267	install-man: man
	268	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
	269	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
	270	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
	271	$(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
	272	$(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
	273	$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
	274
	275	install-info: info
	276	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
	277	$(INSTALL) -m 644 git.info gitman.info $(DESTDIR)$(infodir)
	278	if test -r $(DESTDIR)$(infodir)/dir; then \
	279	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) git.info ;\
	280	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) gitman.info ;\
	281	else \
	282	echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
	283	fi
	284
	285	install-pdf: pdf
	286	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
	287	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)
	288
	289	install-html: html
	290	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
	291
	292	../GIT-VERSION-FILE: FORCE
	293	$(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE
	294
	295	-include ../GIT-VERSION-FILE
	296
	297	#
	298	# Determine "include::" file references in asciidoc files.
	299	#
	300	docdep_prereqs = \
	301	mergetools-list.made $(mergetools_txt) \
	302	cmd-list.made $(cmds_txt)
	303
	304	doc.dep : $(docdep_prereqs) $(wildcard .txt) $(wildcard config/.txt) build-docdep.perl
	305	$(QUIET_GEN)$(RM) $@+ $@ && \
	306	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
	307	mv $@+ $@
	308
	309	-include doc.dep
	310
	311	cmds_txt = cmds-ancillaryinterrogators.txt \
	312	cmds-ancillarymanipulators.txt \
	313	cmds-mainporcelain.txt \
	314	cmds-plumbinginterrogators.txt \
	315	cmds-plumbingmanipulators.txt \
	316	cmds-synchingrepositories.txt \
	317	cmds-synchelpers.txt \
	318	cmds-purehelpers.txt \
	319	cmds-foreignscminterface.txt
	320
	321	$(cmds_txt): cmd-list.made
	322
	323	cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
	324	$(QUIET_GEN)$(RM) $@ && \
	325	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
	326	date >$@
	327
	328	mergetools_txt = mergetools-diff.txt mergetools-merge.txt
	329
	330	$(mergetools_txt): mergetools-list.made
	331
	332	mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
	333	$(QUIET_GEN)$(RM) $@ && \
	334	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
	335	. ../git-mergetool--lib.sh && \
	336	show_tool_names can_diff "* " \|\| :' >mergetools-diff.txt && \
	337	$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
	338	. ../git-mergetool--lib.sh && \
	339	show_tool_names can_merge "* " \|\| :' >mergetools-merge.txt && \
	340	date >$@
	341
	342	TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK))
	343
	344	GIT-ASCIIDOCFLAGS: FORCE
	345	@FLAGS='$(TRACK_ASCIIDOCFLAGS)'; \
	346	if test x"$$FLAGS" != x"`cat GIT-ASCIIDOCFLAGS 2>/dev/null`" ; then \
	347	echo >&2 " * new asciidoc flags"; \
	348	echo "$$FLAGS" >GIT-ASCIIDOCFLAGS; \
	349	fi
	350
	351	clean:
	352	$(RM) .xml .xml+ .html .html+ .1 .5 *.7
	353	$(RM) .texi .texi+ *.texi++ git.info gitman.info
	354	$(RM) *.pdf
	355	$(RM) howto-index.txt howto/*.html doc.dep
	356	$(RM) technical/*.html technical/api-index.txt
	357	$(RM) SubmittingPatches.txt
	358	$(RM) $(cmds_txt) $(mergetools_txt) *.made
	359	$(RM) manpage-base-url.xsl
	360	$(RM) GIT-ASCIIDOCFLAGS
	361
	362	$(MAN_HTML): %.html : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	363	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	364	$(TXT_TO_HTML) -d manpage -o $@+ $< && \
	365	mv $@+ $@
	366
	367	$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	368	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	369	$(TXT_TO_HTML) -o $@+ $< && \
	370	mv $@+ $@
	371
	372	manpage-base-url.xsl: manpage-base-url.xsl.in
	373	$(QUIET_GEN)sed "s\|@@MAN_BASE_URL@@\|$(MAN_BASE_URL)\|" $< > $@
	374
	375	%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
	376	$(QUIET_XMLTO)$(RM) $@ && \
	377	$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
	378
	379	%.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	380	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	381	$(TXT_TO_XML) -d manpage -o $@+ $< && \
	382	mv $@+ $@
	383
	384	user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
	385	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	386	$(TXT_TO_XML) -d book -o $@+ $< && \
	387	mv $@+ $@
	388
	389	technical/api-index.txt: technical/api-index-skel.txt \
	390	technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
	391	$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
	392
	393	technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
	394	$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \
	395	asciidoc.conf GIT-ASCIIDOCFLAGS
	396	$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
	397
	398	SubmittingPatches.txt: SubmittingPatches
	399	$(QUIET_GEN) cp $< $@
	400
	401	XSLT = docbook.xsl
	402	XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
	403
	404	user-manual.html: user-manual.xml $(XSLT)
	405	$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
	406	xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
	407	mv $@+ $@
	408
	409	git.info: user-manual.texi
	410	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
	411
	412	user-manual.texi: user-manual.xml
	413	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	414	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
	415	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
	416	rm $@++ && \
	417	mv $@+ $@
	418
	419	user-manual.pdf: user-manual.xml
	420	$(QUIET_DBLATEX)$(RM) $@+ $@ && \
	421	$(DBLATEX) -o $@+ $(DBLATEX_COMMON) $< && \
	422	mv $@+ $@
	423
	424	gitman.texi: $(MAN_XML) cat-texi.perl texi.xsl
	425	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	426	($(foreach xml,$(sort $(MAN_XML)),xsltproc -o $(xml)+ texi.xsl $(xml) && \
	427	$(DOCBOOK2X_TEXI) --encoding=UTF-8 --to-stdout $(xml)+ && \
	428	rm $(xml)+ &&) true) > $@++ && \
	429	$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
	430	rm $@++ && \
	431	mv $@+ $@
	432
	433	gitman.info: gitman.texi
	434	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
	435
	436	$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
	437	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
	438	$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
	439	mv $@+ $@
	440
	441	howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
	442	$(QUIET_GEN)$(RM) $@+ $@ && \
	443	'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
	444	mv $@+ $@
	445
	446	$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
	447	$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
	448
	449	WEBDOC_DEST = /pub/software/scm/git/docs
	450
	451	howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
	452	$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt GIT-ASCIIDOCFLAGS
	453	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
	454	sed -e '1,/^$$/d' $< \| \
	455	$(TXT_TO_HTML) - >$@+ && \
	456	mv $@+ $@
	457
	458	install-webdoc : html
	459	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
	460
	461	# You must have a clone of 'git-htmldocs' and 'git-manpages' repositories
	462	# next to the 'git' repository itself for the following to work.
	463
	464	quick-install: quick-install-man
	465
	466	require-manrepo::
	467	@if test ! -d $(MAN_REPO); \
	468	then echo "git-manpages repository must exist at $(MAN_REPO)"; exit 1; fi
	469
	470	quick-install-man: require-manrepo
	471	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir) $(GIT_MAN_REF)
	472
	473	require-htmlrepo::
	474	@if test ! -d $(HTML_REPO); \
	475	then echo "git-htmldocs repository must exist at $(HTML_REPO)"; exit 1; fi
	476
	477	quick-install-html: require-htmlrepo
	478	'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir) $(GIT_MAN_REF)
	479
	480	print-man1:
	481	@for i in $(MAN1_TXT); do echo $$i; done
	482
	483	lint-docs::
	484	$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl
	485
	486	ifeq ($(wildcard po/Makefile),po/Makefile)
	487	doc-l10n install-l10n::
	488	$(MAKE) -C po $@
	489	endif
	490
	491	.PHONY: FORCE