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] go-md2man: use vendored-in version, not system #19351

Merged
merged 1 commit into from
Jul 26, 2023

Conversation

edsantiago
Copy link
Member

go-md2man is fragile, especially around tables (#18678, #19278).
Podman man pages are finely tuned to look OK using v2.02, which
is what we vendor in test/tools, so we should really use it
instead of whatever is installed on the system.

This fixes 'make docs' on RHEL8, broken as of #19278.

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

Fixes broken tables on some RHEL8 man pages

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jul 24, 2023

[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 Jul 24, 2023
@edsantiago edsantiago changed the title go-md2man: use vendored-in version, not system [CI:DOCS] go-md2man: use vendored-in version, not system Jul 24, 2023
@edsantiago
Copy link
Member Author

Well, I guess now we know why we require system go-md2man. Giving up for today.

Makefile Outdated
@@ -145,7 +145,7 @@ override undefine GOBIN
# This must never include the 'hack' directory
export PATH := $(shell $(GO) env GOPATH)/bin:$(PATH)

GOMD2MAN ?= $(shell command -v go-md2man || echo './test/tools/build/go-md2man')
GOMD2MAN ?= './test/tools/build/go-md2man'
Copy link
Member

Choose a reason for hiding this comment

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

I am pretty sure you have to remove the single quotes as they are part of the variable

@edsantiago
Copy link
Member Author

It does not seem to be the quotes.

OSX Cross:

go build -o build/go-md2man ./vendor/github.com/cpuguy83/go-md2man/v2
go: creating work dir: stat podman_tmp_SzEc: no such file or directory

and Windows Cross:

/usr/bin/bash: line 6: ./test/tools/build/go-md2man: cannot execute binary file: Exec format error

@Luap99
Copy link
Member

Luap99 commented Jul 25, 2023

The windows one sets GOOS=windows GOARCH=amd64 so it cannot execute the windows binary on linux.

Note sure on OSX, that error makes no sense to me.

@edsantiago
Copy link
Member Author

The podman_tmp_XXXX one on OSX looks suspiciously like something related to the TMPDIR situation I try to address in #19281: I think make podman-release is being called before make docs, and the bogus TMPDIR is causing harm.

@edsantiago edsantiago marked this pull request as draft July 25, 2023 12:34
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 25, 2023
go-md2man is fragile, especially around tables (containers#18678, containers#19278).
Podman man pages are finely tuned to look OK using v2.02, which
is what we vendor in test/tools, so we should really use it
instead of whatever is installed on the system.

This fixes 'make docs' on RHEL8, broken as of containers#19278.

Signed-off-by: Ed Santiago <[email protected]>
@edsantiago edsantiago marked this pull request as ready for review July 26, 2023 17:16
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 26, 2023
@rhatdan
Copy link
Member

rhatdan commented Jul 26, 2023

LGTM

@lsm5
Copy link
Member

lsm5 commented Jul 26, 2023

since we're building from vendored sources, using vendored go-md2man is cool. Packit tasks are happy except the expected rawhide and el9 failures, which are unrelated issues.

@lsm5
Copy link
Member

lsm5 commented Jul 26, 2023

/lgtm
/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 26, 2023
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2023
@rhatdan rhatdan merged commit b2a857a into containers:main Jul 26, 2023
@edsantiago edsantiago deleted the gomd2man-local branch July 26, 2023 21:09
@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 Oct 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 25, 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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. 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