separate build targets for man and html documentation

This introduces new build targets "man" and "html" which allow building the documentation in the respective formats separately. This helps people with a partial documentation build chain: html pages can be built without xmlto. This is documented in INSTALL now, together with corrections: Before, instructions in INSTALL would build man+html but install man only. Now the instructions build and install both, and new and pre-existing targets are explained. Note that build targets "doc" and "man" correspond to install targets "install-doc install-html" and "install-doc" respectively. This inconsistency is not changed, in order to keep everyone's build scripts from breaking. Signed-off-by: Michael J Gruber <michaeljgruber+gmane@fastmail.fm> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael J Gruber committed Sep 10, 2008 at 10:19 UTC 414851a42ecd6f104de517f628cfc09465ea7fa5

2 files changed +18 -3

INSTALL

+12 -3

@@ -6,7 +6,7 @@ will install the git programs in your own ~/bin/ directory. If you want

6 to do a global install, you can do

8 $ make prefix=/usr all doc info ;# as yourself

9 - # make prefix=/usr install install-doc install-info ;# as root

9 + # make prefix=/usr install install-doc install-html install-info ;# as root

11 (or prefix=/usr/local, of course). Just like any program suite

12 that uses $prefix, the built results have some paths encoded,

@@ -19,7 +19,7 @@ set up install paths (via config.mak.autogen), so you can write instead

19 $ make configure ;# as yourself

20 $ ./configure --prefix=/usr ;# as yourself

21 $ make all doc ;# as yourself

22 - # make install install-doc ;# as root

22 + # make install install-doc install-html;# as root

25 Issues of note:

@@ -89,13 +89,22 @@ Issues of note:

89 inclined to install the tools, the default build target

90 ("make all") does _not_ build them.

92 + "make doc" builds documentation in man and html formats; there are

93 + also "make man", "make html" and "make info". Note that "make html"

94 + requires asciidoc, but not xmlto. "make man" (and thus make doc)

95 + requires both.

96 +

97 + "make install-doc" installs documentation in man format only; there

98 + are also "make install-man", "make install-html" and "make

99 + install-info".

100 +

101 Building and installing the info file additionally requires

102 makeinfo and docbook2X. Version 0.8.3 is known to work.

103

104 The documentation is written for AsciiDoc 7, but "make

105 ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.

106

98 - Alternatively, pre-formatted documentation are available in

107 + Alternatively, pre-formatted documentation is available in

108 "html" and "man" branches of the git repository itself. For

109 example, you could:

110

Makefile

@@ -1267,6 +1267,12 @@ $(XDIFF_LIB): $(XDIFF_OBJS)

1267 doc:

1268 $(MAKE) -C Documentation all

1269

1270 +man:

1271 + $(MAKE) -C Documentation man

1272 +

1273 +html:

1274 + $(MAKE) -C Documentation html

1275 +

1276 info:

1277 $(MAKE) -C Documentation info

1278