[27369] in CVS-changelog-for-Kerberos-V5
krb5 commit: Make sphinx warnings fatal for doc build
daemon@ATHENA.MIT.EDU (Benjamin Kaduk)
Tue Dec 11 16:35:39 2012
Date: Tue, 11 Dec 2012 16:35:35 -0500
From: Benjamin Kaduk <kaduk@mit.edu>
Message-Id: <201212112135.qBBLZZg9024299@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/7b6758a09f92ccc386022bcc86e3a5fea472fdce
commit 7b6758a09f92ccc386022bcc86e3a5fea472fdce
Author: Ben Kaduk <kaduk@mit.edu>
Date: Tue Nov 27 18:45:59 2012 -0500
Make sphinx warnings fatal for doc build
We currently do not have any warnings. Let us keep it that way by
making warnings fatal in maintainer-mode (and configurable on the
buildslaves). Using sphinx-build -W also causes errors to be reported
in the exit status and picked up by make, which is quite useful.
In order to allow the build bot to use -W but end-users to not use it,
SPHINX_ARGS must be passed on the command line; it cannot be set by
the convenience target 'htmlsrc'. Document this.
ticket: 7468 (new)
tags: pullup
target_version: 1.11
doc/build_this.rst | 2 +-
src/doc/Makefile.in | 5 +++--
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/doc/build_this.rst b/doc/build_this.rst
index 4177f58..d31ee23 100644
--- a/doc/build_this.rst
+++ b/doc/build_this.rst
@@ -62,7 +62,7 @@ paths.
You can also do this from an unconfigured source tree with::
cd src/doc
- make -f Makefile.in htmlsrc
+ make -f Makefile.in SPHINX_ARGS= htmlsrc
Building for an OS package or site documentation
diff --git a/src/doc/Makefile.in b/src/doc/Makefile.in
index 1d97728..1986f8f 100644
--- a/src/doc/Makefile.in
+++ b/src/doc/Makefile.in
@@ -1,7 +1,8 @@
mydir=doc
BUILDTOP=$(REL)..
-SPHINX_BUILD=sphinx-build
+SPHINX_ARGS=@MAINT@-W
+SPHINX_BUILD=sphinx-build $(SPHINX_ARGS)
DOXYGEN=doxygen
docsrc=$(top_srcdir)/../doc
@@ -37,7 +38,7 @@ LATEXOPTS=
# release tarball or the web site (that is, without substitutions for
# configured paths). This can be done in an unconfigured source tree
# as:
-# make -f Makefile.in htmlsrc
+# make -f Makefile.in SPHINX_ARGS= htmlsrc
html: composite
rm -rf $(docsrc)/html
$(SPHINX_BUILD) -q rst_composite $(docsrc)/html
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
