Deprecate BUILD_DOCS: generate always the doc target but exclude from default make #434
Conversation
This file contains 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
…rom ALL Signed-off-by: Jose Luis Rivero <[email protected]>
Signed-off-by: Jose Luis Rivero <[email protected]>
Signed-off-by: Jose Luis Rivero <[email protected]>
mjcarroll
approved these changes
Jul 23, 2024
scpeters
added a commit
to gazebo-release/gz-math8-release
that referenced
this pull request
Jul 31, 2024
Follow up to gazebosim/gz-cmake#434. Signed-off-by: Steve Peters <[email protected]>
scpeters
added a commit
to gazebo-release/gz-math8-release
that referenced
this pull request
Jul 31, 2024
Follow up to gazebosim/gz-cmake#434. Signed-off-by: Steve Peters <[email protected]>
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.
🦟 Bug fix
Fixes #228
Summary
The PR deprecates the
BUILD_DOCSparameter (it would still work as expected by rise a deprecation warning) and creates thedoctarget unconditionally excluding it from being part of the ALL target hence it is not being called in the default calls of the build system when no target is specified.I previously started to code the approach of not generating the doc target unless
BUILD_DOCSis set toON. That worked well but looked to me that a more standard approach is to generate always the doc target. The current approach also removes the option ofBUILD_DOCS.Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.