Skip to content

docs: share --reload-systemd option between quadlet install and rm#28388

Open
kovan wants to merge 1 commit intocontainers:mainfrom
kovan:docs/share-reload-systemd-option
Open

docs: share --reload-systemd option between quadlet install and rm#28388
kovan wants to merge 1 commit intocontainers:mainfrom
kovan:docs/share-reload-systemd-option

Conversation

@kovan
Copy link
Copy Markdown

@kovan kovan commented Mar 26, 2026

Extract the --reload-systemd option text into a shared option file
and reference it with @@option in both manpages, following the
established pattern for shared options.

Changes:

  • Create docs/source/markdown/options/reload-systemd.md with the shared option text
  • Rename podman-quadlet-install.1.md to .md.in and use @@option reload-systemd
  • Rename podman-quadlet-rm.1.md to .md.in and use @@option reload-systemd

Fixes #28370

Extract the --reload-systemd option text into a shared option file
at docs/source/markdown/options/reload-systemd.md and reference it
with @@option in both podman-quadlet-install and podman-quadlet-rm
manpages, following the established pattern for shared options.

Rename the manpages from .md to .md.in to indicate preprocessing.

Fixes containers#28370

Signed-off-by: Kit Dallege <xaum.io@gmail.com>
@packit-as-a-service
Copy link
Copy Markdown

[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore.

Copy link
Copy Markdown
Member

@danishprakash danishprakash left a comment

Choose a reason for hiding this comment

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

You would want to run make docs to generate the man pages from the now templated files, and then commit them.

@Honny1
Copy link
Copy Markdown
Member

Honny1 commented Mar 27, 2026

I think that podman-quadlet-install.1.md and podman-quadlet-rm.1.md must be added to .gitignore.

@kovan
Copy link
Copy Markdown
Author

kovan commented Mar 27, 2026

Thanks for the review. I ran hack/markdown-preprocess and the generated .md files look correct (verified in a previous comment).

Looking at the existing pattern - podman-quadlet-list.1.md.in also has a generated .md that is not tracked in git - so I believe the current state is correct: only the .md.in files and the shared option file are committed, and the generated .md files remain untracked.

Should I add them to .gitignore explicitly as @Honny1 suggests, or is the current behavior (untracked but not gitignored) consistent with how other .md.in files are handled?

@TomSweeneyRedHat
Copy link
Copy Markdown
Member

The changes LGTM.
I'm not sure about the .gitignore need.

@Honny1
Copy link
Copy Markdown
Member

Honny1 commented Mar 28, 2026

It should be in this .gitignore file (https://github.com/containers/podman/blob/main/docs/source/markdown/.gitignore), though I didn't check the full path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Share --reload-systemd option between podman quadlet install and podman quadlet rm manpages

4 participants