diff options
author | Joerg Bornemann <joerg.bornemann@qt.io> | 2020-10-27 10:35:07 +0100 |
---|---|---|
committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2020-10-28 10:38:28 +0100 |
commit | da1854c683499cf915cb5cac056ec7a31f5ae882 (patch) | |
tree | ff9f42659ae8a348f457b0079958911286ae334f /cmake/QtDocsHelpers.cmake | |
parent | dfca01e18687987b247e33130dc86738f75aea90 (diff) |
CMake: Re-work documentation targets
The top-level prepare_docs target is supposed to run before the
generate_docs target.
The repository-level targets like prepare_docs_qtbase now also run
before their respective generate targets.
To achieve that, several intermediate targets had to be introduced.
The dependencies for top-level generate_docs look like this:
/--> generate_top_level_docs_Core --\
generate_docs ---> generate_top_level_docs_Gui -----> prepare_docs
\--> ... --/
The dependencies for repo-level generate_docs_<repo> look like this:
/--> generate_repo_docs_Core
generate_docs_qtbase ---> generate_repo_docs_Gui
\--> ...
generate_repo_docs_Core --\
generate_repo_docs_Gui -----> prepare_docs_qtbase
... --/
Analoguous for qch_docs.
And last but not least, the module-level generate_docs_<module> depends
on prepare_docs_<module>, just like before.
The strangely named top-level install targets have been renamed to
install_html_docs, install_qch_docs and install_docs.
The html_docs target is now merely an alias for generate_docs.
Apart from prepare_docs, the top-level targets do not depend on the
repository-level targets anymore. Targets that are just an alias (docs,
install_docs, ...) have been re-defined to depend just on the respective
top-level targets.
Fixes: QTBUG-87758
Change-Id: I24466d3a252d518a30a2064bf876be881c46231f
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'cmake/QtDocsHelpers.cmake')
-rw-r--r-- | cmake/QtDocsHelpers.cmake | 40 |
1 files changed, 21 insertions, 19 deletions
diff --git a/cmake/QtDocsHelpers.cmake b/cmake/QtDocsHelpers.cmake index 7a635eea03..f65fd4a07d 100644 --- a/cmake/QtDocsHelpers.cmake +++ b/cmake/QtDocsHelpers.cmake @@ -131,14 +131,16 @@ function(qt_internal_add_docs) "${include_path_args}" ) - add_custom_target(generate_docs_${target} - DEPENDS ${qdoc_bin} - COMMAND ${CMAKE_COMMAND} -E env ${qdoc_env_args} - ${qdoc_bin} - ${generate_qdocs_args} - ) + foreach(target_prefix generate_top_level_docs generate_repo_docs generate_docs) + add_custom_target(${target_prefix}_${target} + DEPENDS ${qdoc_bin} + COMMAND ${CMAKE_COMMAND} -E env ${qdoc_env_args} ${qdoc_bin} ${generate_qdocs_args}) + endforeach() add_dependencies(generate_docs_${target} prepare_docs_${target}) + add_dependencies(generate_repo_docs_${target} ${qt_docs_prepare_target_name}) + add_dependencies(generate_top_level_docs_${target} prepare_docs) + add_dependencies(generate_docs generate_top_level_docs_${target}) # html docs target add_custom_target(html_docs_${target}) @@ -148,13 +150,18 @@ function(qt_internal_add_docs) set(qch_file_name ${doc_target}.qch) set(qch_file_path ${qdoc_output_dir}/${qch_file_name}) - add_custom_target(qch_docs_${target} - DEPENDS ${qhelpgenerator_bin} - COMMAND ${qhelpgenerator_bin} - "${qdoc_output_dir}/${doc_target}.qhp" - -o "${qch_file_path}" - ) + foreach(target_prefix qch_top_level_docs qch_repo_docs qch_docs) + add_custom_target(${target_prefix}_${target} + DEPENDS ${qhelpgenerator_bin} + COMMAND ${qhelpgenerator_bin} + "${qdoc_output_dir}/${doc_target}.qhp" + -o "${qch_file_path}" + ) + endforeach() add_dependencies(qch_docs_${target} generate_docs_${target}) + add_dependencies(qch_repo_docs_${target} ${qt_docs_generate_target_name}) + add_dependencies(qch_top_level_docs_${target} generate_docs) + add_dependencies(qch_docs qch_top_level_docs_${target}) if (QT_WILL_INSTALL) add_custom_target(install_html_docs_${target} @@ -187,13 +194,8 @@ function(qt_internal_add_docs) add_dependencies(docs_${target} qch_docs_${target}) add_dependencies(${qt_docs_prepare_target_name} prepare_docs_${target}) - add_dependencies(${qt_docs_generate_target_name} generate_docs_${target}) - add_dependencies(${qt_docs_html_target_name} html_docs_${target}) - add_dependencies(${qt_docs_qch_target_name} qch_docs_${target}) - add_dependencies(${qt_docs_target_name} docs_${target}) - add_dependencies(${qt_docs_install_html_target_name} install_html_docs_${target}) - add_dependencies(${qt_docs_install_qch_target_name} install_qch_docs_${target}) - add_dependencies(${qt_docs_install_target_name} install_docs_${target}) + add_dependencies(${qt_docs_generate_target_name} generate_repo_docs_${target}) + add_dependencies(${qt_docs_qch_target_name} qch_repo_docs_${target}) # Make sure that the necessary tools are built when running, # for example 'cmake --build . --target generate_docs'. |