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

[CI:DOCS] podman-run.1.md:detach-keys: spell the default value just once #10629

Merged
merged 1 commit into from
Jun 15, 2021

Conversation

dilyanpalauzov
Copy link
Contributor

No description provided.

@rhatdan
Copy link
Member

rhatdan commented Jun 10, 2021

Where is it specified elsewhere?

BTW You have to sign your commits.

git commit -a --amend -s
git push --force

@dilyanpalauzov
Copy link
Contributor Author

The short description of --detach-keys spells the default value twice. The second mention is three lines after the first one.

@rhatdan
Copy link
Member

rhatdan commented Jun 11, 2021

Ok, But I find it harder to find now. I think we should reorganize the --detach-keys definition up a few lines, to include the defaults under the option. But this is not a hard call on my part. @TomSweeneyRedHat WDYT?

@@ -281,7 +281,7 @@ it in the **containers.conf** file: see **containers.conf(5)** for more informat

#### **--detach-keys**=*sequence*

Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*.
Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature.
Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will set the sequence to the default value of *ctrl-p,ctrl-q*

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proposed wording Specifying "" will set the sequence to the default value of *ctrl-p,ctrl-q* does change the current meaning. I have updated the patch with the new meaning.

@TomSweeneyRedHat
Copy link
Member

I see <ctrl-p>, <ctrl-q> only once in --detach and once in --detach-keys. I think we should have one reference for each option. I think many people if it wasn't in both would miss it. But I did leave a suggestion for reworking it that might help satisfy your concern.

Insisting on “DCO” imposes formalities, that serve self-purpose.  One cannot
assume that the submitter has time or will to read texts about symbolism in
software contributions.  If the system wants to see the text

      nrEAUIEUAIe eanuitdnuae EAIUEAUIAIE »ℓ§444.3.72b)°»°ℓ§euaieauuae

in each commit, people will write this, or any other text, that the system wants to
see.  All such text, which presence is mandated by the system, has the same value.

Signed-off-by: Дилян Палаузов <[email protected]>
@TomSweeneyRedHat
Copy link
Member

LGTM
TYVM @dilyanpalauzov !

@rhatdan
Copy link
Member

rhatdan commented Jun 15, 2021

/approve
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 15, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jun 15, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dilyanpalauzov, rhatdan

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 openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 15, 2021
@openshift-merge-robot openshift-merge-robot merged commit 092b2ec into containers:master Jun 15, 2021
@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 23, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 23, 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants