[driver] Document what a "subcommand" is (NFC) #11940
Closed
Conversation
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
There are a few references to "subcommands" in the repository, but no explanation of what they are. Beef up the docblock for `shouldRunAsSubcommand()` to make things a little clearer. Specifically, I'd like to make the difference between driver jobs and driver subcomnmands clearer. In addition, remove a double negative comment, "If we are not run as 'swift', don't do anything special", and replace it with something a little clearer (in my opinion).
jrose-apple
reviewed
Sep 18, 2017
| @@ -61,7 +61,10 @@ extern int modulewrap_main(ArrayRef<const char *> Args, const char *Argv0, | |||
| extern int swift_format_main(ArrayRef<const char *> Args, const char *Argv0, | |||
| void *MainAddr); | |||
|
|
|||
| /// Determine if the given invocation should run as a subcommand. | |||
| /// Determine if the given invocation should run as a "subcommand". | |||
| /// Examples of "subcommands" are 'swift build' or 'swift-test', which are | |||
There was a problem hiding this comment.
Nitpick: please include a newline here in case anyone ever does run Doxygen on the Swift source.
There was a problem hiding this comment.
Also that should be "swift test", right?
| // We only recognize subcommands in the form of 'swift <name-of-subcommand>'. | ||
| // If we are being run as an executable named something other than 'swift', | ||
| // we do not run a subcommand. This means we do not recognize symlinks with | ||
| // alternate names, for example 'swiftc build', as subcommands. |
There was a problem hiding this comment.
That's not what the original text was getting at. We do want to distinguish "swift" vs. "swiftc", but ideally we wouldn't distinguish "swift" vs. "swift-4.1" (or similar).
|
I’ve integrated this PR and responded to Jordan’s feedback in the linked PR. Thanks y’all. |
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.
There are a few references to "subcommands" in the repository, but no explanation of what they are. Beef up the docblock for
shouldRunAsSubcommand()to make things a little clearer. Specifically, I'd like to make the difference between driver jobs and driver subcomnmands clearer.In addition, remove a double negative comment, "If we are not run as 'swift', don't do anything special", and replace it with something a little clearer (in my opinion).