krb5 commit [krb5-1.11]: Make building docs easier in an unconfigured tree

Tom Yu tlyu at MIT.EDU
Wed Dec 12 16:20:48 EST 2012


https://github.com/krb5/krb5/commit/44f3c0948c42110dcfc4701fc2ff9306fb5883cb
commit 44f3c0948c42110dcfc4701fc2ff9306fb5883cb
Author: Ben Kaduk <kaduk at mit.edu>
Date:   Tue Dec 11 00:13:30 2012 -0500

    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.
    
    (cherry picked from commit f6ef297fe537de3712fce751bad8a597ef32e0ed)
    
    ticket: 7491
    version_fixed: 1.11
    status: resolved

 doc/build_this.rst  |    3 +--
 src/doc/Makefile.in |    9 ++++++---
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/doc/build_this.rst b/doc/build_this.rst
index 26ba047..4177f58 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 5f378bc..1d97728 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.


More information about the cvs-krb5 mailing list