Replace --rootdir (-r) with --source-dir (-S) #59
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
Experience with real codebases suggests that we will eventually want to support the ability to independently identify source and build directories. This commit does not add that functionality, but introduces the "source directory" as a replacement for the concept of a "root directory" without breaking backwards compatibility. Signed-off-by: John Pennycook <john.pennycook@intel.com>
laserkelvin
approved these changes
Feb 26, 2024
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.
Experience with real codebases suggests that we will eventually want to support the ability to independently identify source and build directories.
This commit does not add that functionality, but introduces the "source directory" as a replacement for the concept of a "root directory" without breaking backwards compatibility.
Related issues
The standalone tool in #41 also an
-Sflag. Using-Sconsistently acrosscodebasinandcbicovseems like a good idea.Proposed changes
--source-dir (-S)option.-Sand-rcannot be used at the same time.-rand point towards-Sas its replacement.Note that the default value of
arg.rootdiris changed fromos.getcwd()toNoneto make it easier to detect when one or both flags are supplied. The correct default value is assigned later in the code. We can undo this change and assign a default value directly via argparse when-ris removed.