summaryrefslogtreecommitdiffstats
path: root/llvm/docs
diff options
context:
space:
mode:
authorDan Liew <dan@su-root.co.uk>2014-08-14 11:57:13 +0000
committerDan Liew <dan@su-root.co.uk>2014-08-14 11:57:13 +0000
commitc2867bab2b8060cb028e946e3d10bbdb5bbd4333 (patch)
tree3360fdc2c30e841a8d49adfec26e5961e32f9986 /llvm/docs
parentdb76479d73f5e71c1b436b6ffbb51b1f15022370 (diff)
downloadbcm5719-llvm-c2867bab2b8060cb028e946e3d10bbdb5bbd4333.tar.gz
bcm5719-llvm-c2867bab2b8060cb028e946e3d10bbdb5bbd4333.zip
Add SPHINX_WARNINGS_AS_ERRORS CMake option to allow warnings to not be
treated as errors (which is still the default). This is useful when working on documentation that has existing errors. llvm-svn: 215634
Diffstat (limited to 'llvm/docs')
-rw-r--r--llvm/docs/CMake.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index fca02ef889e..1da123419dc 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -363,6 +363,10 @@ LLVM-specific variables
is enabled). Currently the only target added is ``docs-llvm-man``. Defaults
to ON.
+**SPHINX_WARNINGS_AS_ERRORS**:BOOL
+ If enabled then sphinx documentation warnings will be treated as
+ errors. Defaults to ON.
+
Executing the test suite
========================
OpenPOWER on IntegriCloud