Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doxygen.cmake : make tagfiles processing more consistent #744

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

ManifoldFR
Copy link
Contributor

  • process list as a comma-separated native CMake list (less awkward)
  • fix extraneous whitespaces
  • always use absolute paths (allows dedupe to work)
  • remove custom REMOVE_DUPLICATES() function

- process list as a comma-separated native CMake list
- fix extraneous whitespaces
- always use absolute paths (allows dedupe to work)
- remove custom REMOVE_DUPLICATES() function
@ManifoldFR ManifoldFR force-pushed the topic/tagfiles-consistency-fix branch from 8a426f9 to a771dc7 Compare January 29, 2025 13:11
@ManifoldFR
Copy link
Contributor Author

ManifoldFR commented Jan 29, 2025

As discussed with @jorisv, the following lines:

if(EXISTS ${PROJECT_BINARY_DIR}/doc/${PROJECT_NAME}.doxytag)
install(
FILES ${PROJECT_BINARY_DIR}/doc/${PROJECT_NAME}.doxytag
DESTINATION ${CMAKE_INSTALL_FULL_DOCDIR}/doxygen-html
)
endif()

Mess up the installation of doxytags when doing cmake <insert-cmake-args-here> && make install.
Because on the first CMake configuration, the doxytag file in build/doc doesn't exist yet, so the install() for it is not registered.

This change was made in 9fead16

…atch the install-tree

+ simplify installation of doxytag file, simplify cleanup config
@ManifoldFR ManifoldFR force-pushed the topic/tagfiles-consistency-fix branch from 60c3691 to 1707f20 Compare January 29, 2025 15:19
@ManifoldFR
Copy link
Contributor Author

We've found a workaround with @jorisv, which is to make the doxytag file's build-tree relative location the same as its install-tree location -- that is, doc/doxygen-html. Before, the locations would be <build-dir>/doc/${PROJECT_NAME}.doxytag and <install-dir>/doxygen-html/${PROJECT_NAME}.doxytag.

We gain:

  • better consistency
  • no need that the tagfile exists before installing (let it be carried with the doxygen-html directory which is installed wholesale)
  • easier to clean up

@jorisv jorisv merged commit 2ede15d into jrl-umi3218:master Jan 29, 2025
2 checks passed
@ManifoldFR ManifoldFR deleted the topic/tagfiles-consistency-fix branch January 30, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants