Skip to content

build man pages consistently across libs - #956

Open
comick wants to merge 1 commit into
podman-container-tools:mainfrom
comick:man-links
Open

build man pages consistently across libs#956
comick wants to merge 1 commit into
podman-container-tools:mainfrom
comick:man-links

Conversation

@comick

@comick comick commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

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

For example it can be set to `bridge`, `host`, `none`, `pasta` and more, see the [podman-create(1)](https://docs.podman.io/en/latest/markdown/podman-create.1.html#network-mode-net)

though it should then be safer to add more, if merged.

@github-actions github-actions Bot added the common Related to "common" package label Jul 1, 2026
@packit-as-a-service

Copy link
Copy Markdown

Packit jobs failed. @containers/packit-build please check.

@comick
comick marked this pull request as ready for review July 1, 2026 20:38

@mtrmac mtrmac left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread common/docs/Makefile Outdated
Comment thread common/docs/Makefile Outdated
@comick
comick marked this pull request as draft July 27, 2026 09:09
@github-actions github-actions Bot added storage Related to "storage" package image Related to "image" package labels Jul 27, 2026
@comick comick changed the title preprocess md man files to improve cross-links build man pages consistently across libs Jul 27, 2026
@comick

comick commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the initial feedback.
Turning this into draft until agreed on the approach.

I'd like to do this in three steps:

  1. (this PR) introduce a shared way to build man pages across common, image and storage libs
  2. introduce the links cleaning preprocessing (like podman)
  3. add links to man pages

As for this PR, /hack/man-docs.mk is introduced (podman seems to use this folder for similar helpers, but please advice) to provide reusable docs/install/clean targets, which are in turn used in common/image/storage own Makefiles. This is used in common and storage docs Makefiles. image had no docs Makefile (did man stuff in top-level Makefile), which is now introduced for consistency.

The man-docs.mk is where I'd later put the pre-processing/links-cleaning in step 2.

I tried to keep install target folders intact and tested by comparing the content of destination dir ($DEST_DIR/usr/share/man...) with and without my change and ensuring content matches

@comick
comick force-pushed the man-links branch 2 times, most recently from 52444e0 to fafb44b Compare July 27, 2026 11:00
Signed-off-by: Michele Comignano <mcdev@playlinux.net>
@comick
comick requested a review from mtrmac July 27, 2026 14:11
@comick
comick marked this pull request as ready for review August 5, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

common Related to "common" package image Related to "image" package storage Related to "storage" package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants