This is an archive of the discontinued LLVM Phabricator instance.

Differential D24982

[cmake] Include component in Sphinx install rules
ClosedPublic

Authored by mgorny on Sep 27 2016, 1:06 PM.

Details

Reviewers
beanz
delcypher
Commits
rG0ed8bb43a8b8: [cmake] Include component in Sphinx install rules
rL288656: [cmake] Include component in Sphinx install rules
Summary

Include component in install rules for Sphinx targets. Based on a similar suggestion for other doc targets in D24935.

Diff Detail

Event Timeline

mgorny updated this revision to Diff 72697.Sep 27 2016, 1:06 PM
mgorny retitled this revision from to [cmake] Include component in Sphinx install rules.
mgorny updated this object.
mgorny added reviewers: beanz, delcypher.
mgorny added a subscriber: llvm-commits.
Herald added subscribers: mgorny, beanz. · View Herald TranscriptSep 27 2016, 1:06 PM
delcypher accepted this revision.Dec 4 2016, 2:16 AM
delcypher edited edge metadata.

LGTM.

This revision is now accepted and ready to land.Dec 4 2016, 2:16 AM
Closed by commit rL288656: [cmake] Include component in Sphinx install rules (authored by mgorny). · Explain WhyDec 5 2016, 1:25 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
cmake/
modules/
2 lines

Diff 72697

cmake/modules/AddSphinxTarget.cmake

Show First 20 Lines • Show All 44 Lines • ▼ Show 20 Linesfunction (add_sphinx_target builder project)
if (LLVM_BUILD_DOCS) if (LLVM_BUILD_DOCS)
add_dependencies(sphinx ${SPHINX_TARGET_NAME}) add_dependencies(sphinx ${SPHINX_TARGET_NAME})
# Handle installation # Handle installation
if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY) if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
if (builder STREQUAL man) if (builder STREQUAL man)
# FIXME: We might not ship all the tools that these man pages describe # FIXME: We might not ship all the tools that these man pages describe
install(DIRECTORY "${SPHINX_BUILD_DIR}/" # Slash indicates contents of install(DIRECTORY "${SPHINX_BUILD_DIR}/" # Slash indicates contents of
COMPONENT "${project}-sphinx-man"
DESTINATION share/man/man1) DESTINATION share/man/man1)
elseif (builder STREQUAL html) elseif (builder STREQUAL html)
string(TOUPPER "${project}" project_upper) string(TOUPPER "${project}" project_upper)
set(${project_upper}_INSTALL_SPHINX_HTML_DIR "share/doc/${project}/html" set(${project_upper}_INSTALL_SPHINX_HTML_DIR "share/doc/${project}/html"
CACHE STRING "HTML documentation install directory for ${project}") CACHE STRING "HTML documentation install directory for ${project}")
# '/.' indicates: copy the contents of the directory directly into # '/.' indicates: copy the contents of the directory directly into
# the specified destination, without recreating the last component # the specified destination, without recreating the last component
# of ${SPHINX_BUILD_DIR} implicitly. # of ${SPHINX_BUILD_DIR} implicitly.
install(DIRECTORY "${SPHINX_BUILD_DIR}/." install(DIRECTORY "${SPHINX_BUILD_DIR}/."
COMPONENT "${project}-sphinx-html"
DESTINATION "${${project_upper}_INSTALL_SPHINX_HTML_DIR}") DESTINATION "${${project_upper}_INSTALL_SPHINX_HTML_DIR}")
else() else()
message(WARNING Installation of ${builder} not supported) message(WARNING Installation of ${builder} not supported)
endif() endif()
endif() endif()
endif() endif()
endfunction() endfunction()