Skip to content

Fixes usage description of update_checkout.py #30426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 16, 2020

Conversation

valeriyvan
Copy link
Contributor

/swift/utils/update-checkout --help outputs

usage: update-checkout [-h] [--clone] [--clone-with-ssh] [--skip-history]
                       [--skip-repository DIRECTORY] [--scheme BRANCH-SCHEME]
                       [--reset-to-remote] [--clean] [--config CONFIG]
                       [--github-comment GITHUB-COMMENT] [--dump-hashes]
                       [--dump-hashes-config BRANCH-SCHEME-NAME]
                       [--tag TAG-NAME] [--match-timestamp] [-j N_PROCESSES]
                       [--source-root SOURCE_ROOT]

repositories.

By default, updates your checkouts of Swift, SourceKit, LLDB, and SwiftPM.

optional arguments:
  -h, --help            show this help message and exit
  --clone               Obtain Sources for Swift and Related Projects
  --clone-with-ssh      Obtain Sources for Swift and Related Projects via SSH
  --skip-history        Skip histories when obtaining sources
  --skip-repository DIRECTORY
                        Skip the specified repository
  --scheme BRANCH-SCHEME
                        Use branches from the specified branch-scheme. A
                        "branch-scheme" is a list of (repo, branch) pairs.
  --reset-to-remote     Reset each branch to the remote state.
  --clean               Clean unrelated files from each repository.
  --config CONFIG       Configuration file to use
  --github-comment GITHUB-COMMENT
                        Check out related pull requests referenced in the
                        given free-form GitHub-style comment.
  --dump-hashes         Dump the git hashes of all repositories being tracked
  --dump-hashes-config BRANCH-SCHEME-NAME
                        Dump the git hashes of all repositories packaged into
                        update-checkout-config.json
  --tag TAG-NAME        Check out each repository to the specified tag.
  --match-timestamp     Check out adjacent repositories to match timestamp of
                        current swift checkout.
  -j N_PROCESSES, --jobs N_PROCESSES
                        Number of threads to run at once
  --source-root SOURCE_ROOT
                        The root directory to checkout repositories

Fixes it to be:

usage: update-checkout [-h] [--clone] [--clone-with-ssh] [--skip-history]
                       [--skip-repository DIRECTORY] [--scheme BRANCH-SCHEME]
                       [--reset-to-remote] [--clean] [--config CONFIG]
                       [--github-comment GITHUB-COMMENT] [--dump-hashes]
                       [--dump-hashes-config BRANCH-SCHEME-NAME]
                       [--tag TAG-NAME] [--match-timestamp] [-j N_PROCESSES]
                       [--source-root SOURCE_ROOT]

By default, updates your checkouts of Swift, SourceKit, LLDB, and SwiftPM
repositories.

optional arguments:
  -h, --help            show this help message and exit
  --clone               Obtain Sources for Swift and Related Projects
  --clone-with-ssh      Obtain Sources for Swift and Related Projects via SSH
  --skip-history        Skip histories when obtaining sources
  --skip-repository DIRECTORY
                        Skip the specified repository
  --scheme BRANCH-SCHEME
                        Use branches from the specified branch-scheme. A
                        "branch-scheme" is a list of (repo, branch) pairs.
  --reset-to-remote     Reset each branch to the remote state.
  --clean               Clean unrelated files from each repository.
  --config CONFIG       Configuration file to use
  --github-comment GITHUB-COMMENT
                        Check out related pull requests referenced in the
                        given free-form GitHub-style comment.
  --dump-hashes         Dump the git hashes of all repositories being tracked
  --dump-hashes-config BRANCH-SCHEME-NAME
                        Dump the git hashes of all repositories packaged into
                        update-checkout-config.json
  --tag TAG-NAME        Check out each repository to the specified tag.
  --match-timestamp     Check out adjacent repositories to match timestamp of
                        current swift checkout.
  -j N_PROCESSES, --jobs N_PROCESSES
                        Number of threads to run at once
  --source-root SOURCE_ROOT
                        The root directory to checkout repositories

Resolves SR-NNNN.

@shahmishal
Copy link
Member

@swift-ci Python lint

@shahmishal shahmishal self-requested a review March 16, 2020 17:26
@shahmishal
Copy link
Member

@swift-ci smoke test and merge

@swift-ci swift-ci merged commit 9dafc3b into swiftlang:master Mar 16, 2020
@valeriyvan valeriyvan deleted the update_checkout.py branch March 16, 2020 21:25
@AnthonyLatsis AnthonyLatsis added the update-checkout Area → utils: the `update-checkout` script label Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
update-checkout Area → utils: the `update-checkout` script
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants