preprocess md man files to improve cross-links#956
Open
comick wants to merge 1 commit into
Open
Conversation
Signed-off-by: Michele Comignano <mcdev@playlinux.net>
|
Packit jobs failed. @containers/packit-build please check. |
mtrmac
reviewed
Jul 2, 2026
mtrmac
left a comment
mtrmac
left a comment
Contributor
There was a problem hiding this comment.
Thanks! The goal makes sense in general.
We have 2 other sets of man pages here. I suppose this should be centralized in a single shell script called from all those places.
I didn’t read the implementation any further than those 2 comments now.
| DATADIR := ${PREFIX}/share | ||
| MANDIR := $(DATADIR)/man | ||
| GOMD2MAN ?= $(shell command -v go-md2man || echo '$(GOBIN)/go-md2man') | ||
| ifeq ($(NATIVE_GOOS),freebsd) |
| # 5. Replace "\" (backslash) at EOL with two spaces (no idea why) | ||
| # Then two sanity checks: | ||
| # 1. test for "included file options/blahblah"; this indicates a failure | ||
| # in the markdown-preprocess tool; and |
Contributor
There was a problem hiding this comment.
No markdown-preprocess here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This wants to address #827 by adopting the exact same filtering found at https://github.com/podman-container-tools/podman/blob/63cf53d26a579ca8891d83f68fbaa1bf9c957a20/Makefile#L583.
Note that, as of PR creation, the only affected link is found at
container-libs/common/docs/containers.conf.5.md
Line 339 in 4e1a536
though it should then be safer to add more, if merged.