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] Man pages: refactor common options: --shm-size #15810

Merged

Conversation

edsantiago
Copy link
Member

Mostly went with the podman-run version. For ease of review, I
kept the "you" word -- I will fix that in my in-progress
cleanup PR.

This affects lots of files, each of which had slightly different
wording, but this actually isn't as bad as it looks. The diffs
were minor, and I'm pretty sure the new refactored text applies
equally well to all the man pages.

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

more man-page deduplication

@edsantiago edsantiago added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 14, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 14, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 14, 2022
@rhatdan
Copy link
Member

rhatdan commented Sep 14, 2022

This option conflicts with --ipc=host when running containers.
Should be in the shared block, I believe.

@edsantiago
Copy link
Member Author

Oh, indeed:

$ bin/podman run --shm-size=100k --ipc=host quay.io/libpod/testimage:20220615 date
Error: invalid config provided: cannot set shmsize when running in the {host } IPC Namespace

I only left it in the pod files, because it was only present in the pod files. Looks like the "conflict" wording dates to #14625 on 2022-06-21 in both of the pod man pages. Should I keep the "when running containers" text, or just leave it as "This option conflicts with --ipc=host" ?

Thank you for catching that!

@rhatdan
Copy link
Member

rhatdan commented Sep 14, 2022

I would just leave it as conflicts with ipc=host.

Mostly went with the podman-run version. For ease of review, I
kept the "you" word -- I will fix that in my in-progress
cleanup PR.

This affects lots of files, each of which had slightly different
wording, but this actually isn't as bad as it looks. The diffs
were minor, and I'm pretty sure the new refactored text applies
equally well to all the man pages.

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

So done. Rebased and repushed. Thanks again, that was a subtle one!

@rhatdan
Copy link
Member

rhatdan commented Sep 14, 2022

LGTM

@rhatdan
Copy link
Member

rhatdan commented Sep 14, 2022

@containers/podman-maintainers PTAL

Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 15, 2022
@openshift-merge-robot openshift-merge-robot merged commit c8bd81c into containers:main Sep 15, 2022
@edsantiago edsantiago deleted the docs_dedup_shmsize branch September 15, 2022 11:21
@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 20, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 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. kind/documentation Categorizes issue or PR as related to documentation. 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. release-note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants