diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-12-11 00:13:30 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-12-11 16:34:58 -0500 |
| commit | f6ef297fe537de3712fce751bad8a597ef32e0ed (patch) | |
| tree | cf97199a762d0ec9872b2a536938b330440a7761 | |
| parent | f2cec6d908a8b15908f4de199540e5ad3486882b (diff) | |
| download | krb5-f6ef297fe537de3712fce751bad8a597ef32e0ed.tar.gz krb5-f6ef297fe537de3712fce751bad8a597ef32e0ed.tar.xz krb5-f6ef297fe537de3712fce751bad8a597ef32e0ed.zip | |
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
| -rw-r--r-- | doc/build_this.rst | 3 | ||||
| -rw-r--r-- | 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 26ba0479c..4177f58dd 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 5f378bc85..1d977284a 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. |