[llvm] r282536 - [cmake] Support overriding remaining HTML doc install directories

[Michal Gorny via llvm-commits]

Author: mgorny
Date: Tue Sep 27 14:52:29 2016
New Revision: 282536

URL: http://llvm.org/viewvc/llvm-project?rev=282536&view=rev
Log:
[cmake] Support overriding remaining HTML doc install directories

Support overriding the Doxygen & OCamldoc install directories,
and provide a more FHS-compliant defaults for both of them. This extends
r282240 that added this override for Sphinx-built documentation.

LLVM_INSTALL_DOXYGEN_HTML_DIR and LLVM_INSTALL_OCAMLDOC_HTML_DIR are
added, to control the location where Doxygen-generated and
OCamldoc-generated HTML docs are installed appropriately. They both
specify CMake-style install paths, and therefore can either by relative
to the install prefix or absolute.

The new defaults are subdirectories of share/doc/llvm, and replace
the previous directories of 'docs/html' and 'docs/ocaml/html' that
resulted in creating invalid '/usr/docs' that furthermore lacked proper
namespacing for the LLVM package. The new defaults are consistent with
the ones used for Sphinx HTML documentation, differing only in the last
component. Since the 'html' subdirectory is already used for Sphinx
docs, the 'doxygen-html' and 'ocaml-html' directories are used instead.

Differential Revision: https://reviews.llvm.org/D24935

Modified:
    llvm/trunk/CMakeLists.txt
    llvm/trunk/docs/CMake.rst
    llvm/trunk/docs/CMakeLists.txt

Modified: llvm/trunk/CMakeLists.txt
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/CMakeLists.txt?rev=282536&r1=282535&r2=282536&view=diff
==============================================================================
--- llvm/trunk/CMakeLists.txt (original)
+++ llvm/trunk/CMakeLists.txt Tue Sep 27 14:52:29 2016
@@ -456,6 +456,11 @@ option (LLVM_ENABLE_DOXYGEN "Use doxygen
 option (LLVM_ENABLE_SPHINX "Use Sphinx to generate llvm documentation." OFF)
 option (LLVM_ENABLE_OCAMLDOC "Build OCaml bindings documentation." ON)
 
+set(LLVM_INSTALL_DOXYGEN_HTML_DIR "share/doc/llvm/doxygen-html"
+    CACHE STRING "Doxygen-generated HTML documentation install directory")
+set(LLVM_INSTALL_OCAMLDOC_HTML_DIR "share/doc/llvm/ocaml-html"
+    CACHE STRING "OCamldoc-generated HTML documentation install directory")
+
 option (LLVM_BUILD_EXTERNAL_COMPILER_RT
   "Build compiler-rt as an external project." OFF)
 

Modified: llvm/trunk/docs/CMake.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMake.rst?rev=282536&r1=282535&r2=282536&view=diff
==============================================================================
--- llvm/trunk/docs/CMake.rst (original)
+++ llvm/trunk/docs/CMake.rst Tue Sep 27 14:52:29 2016
@@ -431,6 +431,11 @@ LLVM-specific variables
   Uses .svg files instead of .png files for graphs in the Doxygen output.
   Defaults to OFF.
 
+**LLVM_INSTALL_DOXYGEN_HTML_DIR**:STRING
+  The path to install Doxygen-generated HTML documentation to. This path can
+  either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
+  `share/doc/llvm/doxygen-html`.
+
 **LLVM_ENABLE_SPHINX**:BOOL
   If specified, CMake will search for the ``sphinx-build`` executable and will make
   the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.
@@ -461,6 +466,11 @@ LLVM-specific variables
   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
   `share/doc/llvm/html`.
 
+**LLVM_INSTALL_OCAMLDOC_HTML_DIR**:STRING
+  The path to install OCamldoc-generated HTML documentation to. This path can
+  either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
+  `share/doc/llvm/ocaml-html`.
+
 **LLVM_CREATE_XCODE_TOOLCHAIN**:BOOL
   OS X Only: If enabled CMake will generate a target named
   'install-xcode-toolchain'. This target will create a directory at

Modified: llvm/trunk/docs/CMakeLists.txt
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMakeLists.txt?rev=282536&r1=282535&r2=282536&view=diff
==============================================================================
--- llvm/trunk/docs/CMakeLists.txt (original)
+++ llvm/trunk/docs/CMakeLists.txt Tue Sep 27 14:52:29 2016
@@ -93,8 +93,11 @@ if (LLVM_ENABLE_DOXYGEN)
   endif()
 
   if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
-    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html
-      DESTINATION docs/html)
+    # ./ suffix is needed to copy the contents of html directory without
+    # appending html/ into LLVM_INSTALL_DOXYGEN_HTML_DIR.
+    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/.
+      COMPONENT doxygen-html
+      DESTINATION "${LLVM_INSTALL_DOXYGEN_HTML_DIR}")
   endif()
 endif()
 endif()
@@ -154,7 +157,10 @@ if( NOT uses_ocaml LESS 0 AND LLVM_ENABL
   add_dependencies(ocaml_doc ${doc_targets})
 
   if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
-    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
-      DESTINATION docs/ocaml/html)
+    # ./ suffix is needed to copy the contents of html directory without
+    # appending html/ into LLVM_INSTALL_OCAMLDOC_HTML_DIR.
+    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html/.
+      COMPONENT ocamldoc-html
+      DESTINATION "${LLVM_INSTALL_OCAMLDOC_HTML_DIR}")
   endif()
 endif()