From: Ben Kaduk <kaduk@mit.edu>
Date: Tue, 11 Dec 2012 05:13:30 +0000 (-0500)
Subject: Make building docs easier in an unconfigured tree
X-Git-Tag: krb5-1.12-alpha1~427
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f6ef297fe537de3712fce751bad8a597ef32e0ed;p=thirdparty%2Fkrb5.git

Make building docs easier in an unconfigured tree

Instead of requiring the user to specify srcdir, top_srcdir, PYTHON,
and possibly more in the future, make an 'htmlsrc' target that does so
for them.

This also lets us do the clean in the same step, so that only one
command is required of the user.

ticket: 7491 (new)
tags: pullup
target_version: 1.11
---

diff --git a/doc/build_this.rst b/doc/build_this.rst
index 26ba0479c0..4177f58ddb 100644
--- a/doc/build_this.rst
+++ b/doc/build_this.rst
@@ -62,8 +62,7 @@ paths.
 You can also do this from an unconfigured source tree with::
 
     cd src/doc
-    make -f Makefile.in top_srcdir=.. srcdir=. PYTHON=python html
-    make -f Makefile.in clean
+    make -f Makefile.in htmlsrc
 
 
 Building for an OS package or site documentation
diff --git a/src/doc/Makefile.in b/src/doc/Makefile.in
index 5f378bc850..1d977284aa 100644
--- a/src/doc/Makefile.in
+++ b/src/doc/Makefile.in
@@ -36,13 +36,16 @@ LATEXOPTS=
 # Create HTML documentation in $(docsrc)/html suitable for a
 # release tarball or the web site (that is, without substitutions for
 # configured paths).  This can be done in an unconfigured source tree
-# with:
-#     make -f Makefile.in srcdir=. top_srcdir=.. PYTHON=python html
-#     make -f Makefile.in clean
+# as:
+#     make -f Makefile.in htmlsrc
 html: composite
 	rm -rf $(docsrc)/html
 	$(SPHINX_BUILD) -q rst_composite $(docsrc)/html
 
+# Dummy target for use in an unconfigured source tree.
+htmlsrc:
+	$(MAKE) -f Makefile.in srcdir=. top_srcdir=.. PYTHON=python html clean
+
 # Create HTML documentation in html_subst suitable for
 # installation by an OS package, with substitutions for configured
 # paths.