This repository has been archived by the owner on Feb 24, 2020. It is now read-only.
rkt: add long command descriptions #2098
Merged
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
|
Is this worth a CHANGELOG entry? I say yeah. |
blixtra
force-pushed
the
blixtra/add-long-command-descriptions
branch
2 times, most recently
from
6bd2ff1
to
6aa461e
Compare
|
|
||
| Long: `UUID should be the UUID of a running pod. | ||
|
|
||
| By default the CMD run is bash, providing the user with shell access to the |
blixtra
force-pushed
the
blixtra/add-long-command-descriptions
branch
from
6aa461e
to
4d0a66b
Compare
|
Updated |
| Short: "Garbage collect rkt pods no longer in use", | ||
| Long: `This is intended to be run periodically from a timer or cron job. | ||
|
|
||
| Garbage collection is a 2 step process. First, stopped pods are moved to the |
blixtra
force-pushed
the
blixtra/add-long-command-descriptions
branch
from
4d0a66b
to
38b6b22
Compare
|
LGTM |
| @@ -34,7 +34,10 @@ var ( | |||
| cmdFetch = &cobra.Command{ | |||
| Use: "fetch IMAGE_URL...", | |||
| Short: "Fetch image(s) and store them in the local store", | |||
| Run: runWrapper(runFetch), | |||
| Long: `Locates and downloads remote ACIs and their attached signatures. | |||
| If the ACI image is available in the local store, the image will not be fetched | |||
|
Paging @joshix |
|
This needs to be rebased, it has some conflicts. |
| @@ -42,7 +42,11 @@ var ( | |||
| cmdAPIService = &cobra.Command{ | |||
| Use: `api-service [--listen="localhost:15441"]`, | |||
| Short: "Run API service (experimental, DO NOT USE IT)", | |||
| Run: runWrapper(runAPIService), | |||
| Long: `The API service listens for gRPC requests on the address and | |||
There was a problem hiding this comment.
Quoting style: Should Run: value be quoted as it is here, with backticks, or as the value for Short: is quoted, in double quotes?
There was a problem hiding this comment.
I think it is fine as it is: double quotes for single-line strings and backticks for multi-line strings.
blixtra
force-pushed
the
blixtra/add-long-command-descriptions
branch
from
38b6b22
to
d5a45f1
Compare
|
updated and rebased |
|
Thanks |
alban
added a commit
that referenced
this pull request
Feb 4, 2016
…ptions rkt: add long command descriptions
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Most of these changes were inspired by the rkt subcommand documentation.
Closes #2080