[PATCH 1/2] allow installation of man and html doc from the man and html branches

[PATCH 1/2] allow installation of man and html doc from the man and html branches

[Michael J Gruber]

This patch introduces a make target "quick-install-html" which installs
the html documentation from the branch origin/html, without the need for
asciidoc/xmlto. This is analogous to the existing "quick-install-doc"
target for the man pages.

We advertise these targets in the INSTALL file now.

Signed-off-by: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>
---
 Documentation/Makefile |    4 ++++
 INSTALL                |    5 +++++
 Makefile               |    3 +++
 3 files changed, 12 insertions(+), 0 deletions(-)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 62269e3..ded0e40 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -44,6 +44,7 @@ MANPAGE_XSL = callouts.xsl
 INSTALL?=install
 RM ?= rm -f
 DOC_REF = origin/man
+HTML_REF = origin/html
 
 infodir?=$(prefix)/share/info
 MAKEINFO=makeinfo
@@ -222,4 +223,7 @@ install-webdoc : html
 quick-install:
 	sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
 
+quick-install-html:
+	sh ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
+
 .PHONY: .FORCE-GIT-VERSION-FILE
diff --git a/INSTALL b/INSTALL
index 2bae53f..7c13473 100644
--- a/INSTALL
+++ b/INSTALL
@@ -117,6 +117,11 @@ Issues of note:
 
 	http://www.kernel.org/pub/software/scm/git/docs/
 
+   There is also "make quick-install-doc" and "make quick-install-html"
+   which installs man pages resp. html documentation from these branches.
+   This does not require asciidoc/xmlto, but it works from within
+   a checkout of git.git only.
+
    It has been reported that docbook-xsl version 1.72 and 1.73 are
    buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
    the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
diff --git a/Makefile b/Makefile
index f4c31c8..eeaf6d4 100644
--- a/Makefile
+++ b/Makefile
@@ -1401,6 +1401,9 @@ install-info:
 quick-install-doc:
 	$(MAKE) -C Documentation quick-install
 
+quick-install-html:
+	$(MAKE) -C Documentation quick-install-html
+
 
 
 ### Maintainer's dist rules
-- 
1.6.0.1.285.g1070

[PATCH 2/2] separate build targets for man and html documentation

[Michael J Gruber]

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>
---
 INSTALL  |   15 ++++++++++++---
 Makefile |    6 ++++++
 2 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/INSTALL b/INSTALL
index 7c13473..a40d77d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -6,7 +6,7 @@ will install the git programs in your own ~/bin/ directory.  If you want
 to do a global install, you can do
 
 	$ make prefix=/usr all doc info ;# as yourself
-	# make prefix=/usr install install-doc install-info ;# as root
+	# make prefix=/usr install install-doc install-html install-info ;# as root
 
 (or prefix=/usr/local, of course).  Just like any program suite
 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
 	$ make configure ;# as yourself
 	$ ./configure --prefix=/usr ;# as yourself
 	$ make all doc ;# as yourself
-	# make install install-doc ;# as root
+	# make install install-doc install-html;# as root
 
 
 Issues of note:
@@ -89,13 +89,22 @@ Issues of note:
    inclined to install the tools, the default build target
    ("make all") does _not_ build them.
 
+   "make doc" builds documentation in man and html formats; there are
+   also "make man", "make html" and "make info". Note that "make html"
+   requires asciidoc, but not xmlto. "make man" (and thus make doc)
+   requires both.
+
+   "make install-doc" installs documentation in man format only; there
+   are also "make install-man", "make install-html" and "make
+   install-info".
+
    Building and installing the info file additionally requires
    makeinfo and docbook2X.  Version 0.8.3 is known to work.
 
    The documentation is written for AsciiDoc 7, but "make
    ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
 
-   Alternatively, pre-formatted documentation are available in
+   Alternatively, pre-formatted documentation is available in
    "html" and "man" branches of the git repository itself.  For
    example, you could:
 
diff --git a/Makefile b/Makefile
index eeaf6d4..66e1982 100644
--- a/Makefile
+++ b/Makefile
@@ -1265,6 +1265,12 @@ $(XDIFF_LIB): $(XDIFF_OBJS)
 doc:
 	$(MAKE) -C Documentation all
 
+man:
+	$(MAKE) -C Documentation man
+
+html:
+	$(MAKE) -C Documentation html
+
 info:
 	$(MAKE) -C Documentation info
 
-- 
1.6.0.1.285.g1070

[PATCH 0/2] Assist installing documentation with incomplete build chain

[Michael J Gruber]

This patch series should clarify make targets for documentation and
help those with partial or no documentation build chain, without breaking
existing behaviour. Therefore, the current inconsistency between "make
doc" (builds man and html doc) and "make install-doc" (installs man) is
preserved.

The INSTALL file documents this now, as well as preexisting and new
targets for building and installing man and html separately or from the
convenience branches origin/{man,html}.

Michael J Gruber (2):
  allow installation of man and html doc from the man and html branches
  separate build targets for man and html documentation

 Documentation/Makefile |    4 ++++
 INSTALL                |   20 +++++++++++++++++---
 Makefile               |    9 +++++++++
 3 files changed, 30 insertions(+), 3 deletions(-)

Re: [PATCH 0/2] Assist installing documentation with incomplete build chain

[Michael J Gruber]

I hate to reply to myself, but I apologize for the failed threading.
That series has Message-Id: and In-Reply-To: fields set up
appropriately, but it doesn't show up threaded, at least not here. It
was an attempt at using Thunderbird, by writing format-patch output to
TB's outbox in mbox format (and adding a few lines). I'll try
differently next time (the approach with external editor + TB-config
changes isn't that comfortable either).

Michael