Rename DOCUMENTATION option to WITH_DOCS in CMakeLists.txt #3415
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.
Problem
Fixes #3381
The CMakeLists.txt used
DOCUMENTATIONas the option name, while the README.md and config.mk consistently useWITH_DOCS. This naming inconsistency made it confusing for users who want to disable documentation building.Current State
DOCUMENTATIONoptionWITH_DOCSvariablemake WITH_DOCS=noSolution
Rename the CMake option from
DOCUMENTATIONtoWITH_DOCSto match the Makefile convention and maintain consistency across the build system.Changes
option(DOCUMENTATION ...)tooption(WITH_DOCS ...)if (DOCUMENTATION)→if (WITH_DOCS)WITH_CLIENTS,WITH_BROKER,WITH_APPS,WITH_PLUGINS)Usage
Before:
After:
Backward Compatibility
This is a breaking change for users who explicitly set
-DDOCUMENTATION=OFFin their CMake commands. However:WITH_DOCS)WITH_*naming conventionTesting
ON)