refactor(build): finalize Doxygen input paths and install rules#541
Merged
refactor(build): finalize Doxygen input paths and install rules#541
Conversation
Drop legacy layout references from Doxyfile, cmake/documentation.cmake, and cmake/install.cmake now that the post-EPIC-#531 directory layout is stable. - Doxyfile INCLUDE_PATH: replace removed roots (core/, values/, internal/, integration/) with the canonical include/, include/kcenon/ container/, and src/ paths. - Doxyfile INPUT: keep the canonical roots and explicit docs/*.dox pages; drop the temporary layout-disclaimer comment. - cmake/documentation.cmake DOXYGEN_INPUT: remove the source-root catch-all and the non-existent root mainpage.dox reference; add utilities/ and the explicit docs/*.dox pages so the CMake target and the standalone Doxyfile drive the same set of inputs. - cmake/install.cmake: rewrite the documentation block to reflect the actual install layout (canonical include/kcenon/container/ plus deprecated include/container/), record the v1.2.0 removal milestone for the legacy forwarding tree as a TODO marker, and drop the dropped- install-rule comment that was kept as a breadcrumb during #538/#535. - CHANGELOG.md and docs/CHANGELOG.md: record the cleanup under Unreleased > Changed. All INPUT paths verified to exist on disk. Toolchain unavailable in sandbox; relying on CI for cmake configure, build, and Doxygen target runs. Closes #536 Part of #531
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Summary
Final sub-issue of EPIC #531. Repoint Doxygen
INPUT/INCLUDE_PATHandcmake/documentation.cmakeDOXYGEN_INPUTto the canonical post-migration layout, and tightencmake/install.cmaketo reflect the actual install rules now in effect.Change Type
Affected Components
Doxyfile--INPUT,INCLUDE_PATHcmake/documentation.cmake--DOXYGEN_INPUTcmake/install.cmake-- documentation block, deprecation markerCHANGELOG.md,docs/CHANGELOG.md-- release notesWhy
Problem Solved
After the four prior sub-issues (#532 -- #535) consolidated headers under
include/kcenon/container/, moved.cppfiles intosrc/<subdir>/, deprecated the legacyinclude/container/forwarders, and decomposed the top-level CMakeLists.txt into 11 cmake/ modules, three artifacts still carried drift-fix-only state from issue #533 / #535:Doxyfile INCLUDE_PATHstill referenced removed roots (core/,values/,internal/,integration/).cmake/documentation.cmake DOXYGEN_INPUTlisted${CMAKE_CURRENT_SOURCE_DIR}as a catch-all (pulling in build artifacts and unrelated metadata) and pointed at a non-existent rootmainpage.dox.cmake/install.cmakedocumentation block still enumerated removed root-level forwarding directories, and the deprecatedinclude/container/install rule had no recorded removal milestone.Related Issues
Who
Reviewers
When
Urgency
Target Release
The cleanup itself is part of
[Unreleased]. The TODO marker on the deprecatedinclude/container/install rule namesv1.2.0as the removal milestone, matching the deprecation cycle started in #534/PR #539.Where
Files Changed
DoxyfileINCLUDE_PATH; drop temporary layout-disclaimer comment aboveINPUTcmake/documentation.cmakeDOXYGEN_INPUT; align comment with the standalone Doxyfilecmake/install.cmakev1.2.0TODO marker; drop dropped-rule breadcrumbCHANGELOG.mdUnreleased > Changeddocs/CHANGELOG.mdUnreleased > ChangedAPI/Database Changes
None. Public C++ API unchanged. CMake export set, package config, target name, namespace, and install destinations are unchanged. The set of installed headers is identical to the pre-refactor state (canonical
include/kcenon/container/+ deprecatedinclude/container/).How
Implementation Highlights
Doxyfile
INPUTwas already canonical (set in #538). Only the temporary disclaimer comment was rewritten to describe current state instead of pointing at #533/#536.INCLUDE_PATHpreviously listedcore values internal integration-- those root directories were removed in #533/PR #538. Replaced withinclude,include/kcenon/container, andsrcso Doxygen's preprocessor can resolve#includedirectives in the new layout.cmake/documentation.cmake
DOXYGEN_INPUTpreviously had two issues:${CMAKE_CURRENT_SOURCE_DIR}(source root catch-all) -- pulls in.git/,cmake/, top-level scripts, and the like; doxygen has to filter them viaEXCLUDEpatterns rather than not loading them in the first place.${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox-- the file lives atdocs/mainpage.dox, not at the source root. The path resolved to a non-existent file and would have produced a Doxygen warning had the target been exercised.Repointed to the same set of inputs as the standalone
Doxyfile:include/kcenon/container/,src/,examples/,utilities/,README.md, and the explicitdocs/*.doxpages.cmake/install.cmake
The install rules themselves are unchanged. Only the comments were rewritten:
core/,internal/,integration/,messaging/) that haven't been installed since [#531-2/5] Source migration to src/{core,internal,integration,messaging}/ #533. Tightened to the two directories actually being installed.Forwarding headers under include/container/comment now records the deprecation cycle ([#531-3/5] Mark legacy include/container/ forwarding [[deprecated]] #534, PR refactor(container): deprecate legacy include/container/ forwarding headers #539) and the v1.2.0 removal milestone via aTODO(v1.2.0)marker.Verification
Doxyfile INPUTpaths and all 4INCLUDE_PATHentries exist on disk (verified with[ -e <path> ]).${CMAKE_CURRENT_SOURCE_DIR}/...paths inDOXYGEN_INPUTexist on disk (build/, build_test/, vcpkg/, vcpkg_installed/ are EXCLUDE entries and are expected to be absent until configure/build).cmake/install.cmakeexist (container.h,include/kcenon,include/container,cmake/container_system-config.cmake.in).Local cmake/g++/doxygen toolchains are unavailable in this sandbox; relying on CI for the cmake configure pass, the multi-platform build, ctest, and the Documentation Audit step (per
ci-resilience.md).Testing Done
INPUTandINCLUDE_PATHentryDOXYGEN_INPUTandinstall(...)source entrydoxygennot installed in sandbox; CI covers this)cmakenot installed in sandbox; CI covers this)cmake --install build/ --prefix /tmp/inst-- skipped (same reason; install rules unchanged in substance)Breaking Changes
None.
Rollback Plan
Plain revert of this PR. The five EPIC #531 sub-issue PRs land in order #537 -> #538 -> #539 -> #540 -> this one, so reverting in reverse order is safe.
Checklist
cmake/doxygenavailable locally)Closes #536) and EPIC reference (Part of #531)