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

Add man pages to Mac installer #24789

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Conversation

baude
Copy link
Member

@baude baude commented Dec 6, 2024

This PR adds the man1 pages to the mac installer. It also sticks a small configuration file into /usr/local/etc/man.d that allows macos and the man binary to look for the podman pages in /opt/podman/docs/man.

Fixes #24756

Does this PR introduce a user-facing change?

Add man1 pages to Mac installer

Copy link
Contributor

openshift-ci bot commented Dec 6, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: baude

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 Dec 6, 2024
@baude baude added the No New Tests Allow PR to proceed without adding regression tests label Dec 6, 2024
Copy link
Member

@ashley-cui ashley-cui left a comment

Choose a reason for hiding this comment

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

Tested and the manpage installation works, just one small build target change

contrib/pkginstaller/package.sh Outdated Show resolved Hide resolved
contrib/pkginstaller/package.sh Outdated Show resolved Hide resolved
contrib/pkginstaller/scripts/postinstall Outdated Show resolved Hide resolved

version=$(cat "${BASEDIR}/VERSION")
arch=$(cat "${BASEDIR}/ARCH")

function build_podman() {
pushd "$1"

make docs
mkdir -p "contrib/pkginstaller/out/packaging/${docDir}"
cp -v docs/build/man/*.1 "contrib/pkginstaller/out/packaging/${docDir}"
Copy link
Member

Choose a reason for hiding this comment

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

This seems to assume that we only ship .1 pages which is not true, we also have podman-systemd.unit.5.md

Copy link
Member Author

Choose a reason for hiding this comment

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

i think for the mac client, this makes sense?

This PR adds the man1 pages to the mac installer.  It also sticks a
small configuration file into /usr/local/etc/man.d that allows macos
and the man binary to look for the podman pages in /opt/podman/docs/man.

Fixes containers#24756

Signed-off-by: Brent Baude <[email protected]>
Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

LGTM

@mheon
Copy link
Member

mheon commented Dec 10, 2024

LGTM

@mheon
Copy link
Member

mheon commented Dec 10, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 10, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 58bbe14 into containers:main Dec 10, 2024
40 checks passed
@baude
Copy link
Member Author

baude commented Dec 11, 2024

/cherry-pick v5.3

@openshift-cherrypick-robot
Copy link
Collaborator

@baude: new pull request created: #24820

In response to this:

/cherry-pick v5.3

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-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. No New Tests Allow PR to proceed without adding regression tests release-note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing man pages in installer (macOS)
5 participants