Skip to content
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

Better usage synopses for subcommands #2456

Merged
merged 1 commit into from
Feb 27, 2019

Conversation

edsantiago
Copy link
Member

Conceptually simple: include, where applicable, a brief
description of command-line options for each subcommand.

Signed-off-by: Ed Santiago [email protected]

@openshift-ci-robot openshift-ci-robot added size/L needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 26, 2019
@openshift-ci-robot
Copy link
Collaborator

Hi @edsantiago. Thanks for your PR.

I'm waiting for a containers or openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@edsantiago
Copy link
Member Author

VERY LOW PRIORITY. And I realize of course that I'll need to rebase after (if) #2452 is merged.

I also realize it'll be tedious to review. I'm sorry. Possible suggestions:

$ git log -1 -p | egrep '^\+\s' |less
[shows a brief summary of each added line]

$ egrep -r 'Use: *"[a-z]+"' cmd/podman
[shows the ones I omitted or missed.]
FIXME: I'd like suggestions for 'trust'

@baude PTAL but again very low priority

@edsantiago
Copy link
Member Author

CI failure: gating: because I added DisableFlagsInUseLine (to avoid a misleading addition of "[flags]" to the use string). Someone isn't happy with the indentation. Should I update that in init instead?

Conceptually simple: include, where applicable, a brief
description of command-line options for each subcommand.

Signed-off-by: Ed Santiago <[email protected]>
@baude
Copy link
Member

baude commented Feb 27, 2019

/ok-to-test

@openshift-ci-robot openshift-ci-robot added ok-to-test and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 27, 2019
@baude
Copy link
Member

baude commented Feb 27, 2019

/approve

@openshift-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: baude, edsantiago

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 27, 2019
@baude
Copy link
Member

baude commented Feb 27, 2019

@edsantiago i think this looks great... given it is outward facing, would like thumb up from @rhatdan and @mheon . i pulled the PR and really like how it looks. Adding example for the fellas here:

sudo podman attach --help
The podman attach command allows you to attach to a running container using the container's ID or name, either to view its ongoing output or to control it interactively.

Usage:
  podman attach [flags] CONTAINER
...
sudo podman create --help
Creates a new container from the given image or storage and prepares it for running the specified command. The container ID is then printed to stdout. You can then start it at any time with the podman start <container_id> command. The container will be created with the initial state 'created'.

Usage:
  podman create [flags] IMAGE [COMMAND [ARG...]]

@rhatdan
Copy link
Member

rhatdan commented Feb 27, 2019

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2019
@openshift-merge-robot openshift-merge-robot merged commit f7f266e into containers:master Feb 27, 2019
@edsantiago edsantiago deleted the better_synopses branch February 27, 2019 13:02
edsantiago added a commit to edsantiago/libpod that referenced this pull request Feb 27, 2019
- belatedly incorporate review feedback from baude
- add usage synopsis for trust-set and trust-show

Signed-off-by: Ed Santiago <[email protected]>
openshift-merge-robot added a commit that referenced this pull request Feb 27, 2019
Followup to #2456: update examples, add trust
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 27, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. ok-to-test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants