Ensure --doctool
is run from root directory
#91407
Merged
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.
There are two ways to run doctool:
--doctool
(uses cwd by setting.
as the path)--doctool <path>
(absolute or relative path)While convenient, the former method implicitly relies on the cwd. So it might end up generating
doc
,modules
andplatform
directories inside of your build directory or home directory.Now we check for the existence of the
doc
folder for this case only, to avoid accidents.This is technically a breaking change, but I assume most scripted usage of
--doctool
either runs in the repository root already, or specifies a path in the command line.While we could also check for the
doc
folder in the case of an explicit path being passed, it might be desired to generate the XML structure outside of the repository folder for other purposes (such as a simple to parse list of classes, members, etc.)?