diff options
| author | Dan Liew <dan@su-root.co.uk> | 2014-08-14 11:57:13 +0000 |
|---|---|---|
| committer | Dan Liew <dan@su-root.co.uk> | 2014-08-14 11:57:13 +0000 |
| commit | c2867bab2b8060cb028e946e3d10bbdb5bbd4333 (patch) | |
| tree | 3360fdc2c30e841a8d49adfec26e5961e32f9986 /llvm | |
| parent | db76479d73f5e71c1b436b6ffbb51b1f15022370 (diff) | |
| download | bcm5719-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')
| -rw-r--r-- | llvm/cmake/modules/AddSphinxTarget.cmake | 9 | ||||
| -rw-r--r-- | llvm/cmake/modules/FindSphinx.cmake | 2 | ||||
| -rw-r--r-- | llvm/docs/CMake.rst | 4 |
3 files changed, 14 insertions, 1 deletions
diff --git a/llvm/cmake/modules/AddSphinxTarget.cmake b/llvm/cmake/modules/AddSphinxTarget.cmake index fc28a494078..b78afc173cb 100644 --- a/llvm/cmake/modules/AddSphinxTarget.cmake +++ b/llvm/cmake/modules/AddSphinxTarget.cmake @@ -8,12 +8,19 @@ function (add_sphinx_target builder project) set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/${builder}") set(SPHINX_DOC_TREE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees") set(SPHINX_TARGET_NAME docs-${project}-${builder}) + + if (SPHINX_WARNINGS_AS_ERRORS) + set(SPHINX_WARNINGS_AS_ERRORS_FLAG "-W") + else() + set(SPHINX_WARNINGS_AS_ERRORS_FLAG "") + endif() + add_custom_target(${SPHINX_TARGET_NAME} COMMAND ${SPHINX_EXECUTABLE} -b ${builder} -d "${SPHINX_DOC_TREE_DIR}" -q # Quiet: no output other than errors and warnings. - -W # Warnings are errors. + ${SPHINX_WARNINGS_AS_ERRORS_FLAG} # Treat warnings as errors if requested "${CMAKE_CURRENT_SOURCE_DIR}" # Source "${SPHINX_BUILD_DIR}" # Output COMMENT diff --git a/llvm/cmake/modules/FindSphinx.cmake b/llvm/cmake/modules/FindSphinx.cmake index a2adcae7326..9d252e8b70a 100644 --- a/llvm/cmake/modules/FindSphinx.cmake +++ b/llvm/cmake/modules/FindSphinx.cmake @@ -23,3 +23,5 @@ find_package_handle_standard_args(Sphinx # Provide options for controlling different types of output option(SPHINX_OUTPUT_HTML "Output standalone HTML files" ON) option(SPHINX_OUTPUT_MAN "Output man pages" ON) + +option(SPHINX_WARNINGS_AS_ERRORS "When building documentation treat warnings as errors" ON) 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 ======================== |
