docs: remove hardcoded config paths in favor of man page references (#29187) - #29540
Open
hihry wants to merge 3 commits into
Open
docs: remove hardcoded config paths in favor of man page references (#29187)#29540hihry wants to merge 3 commits into
hihry wants to merge 3 commits into
Conversation
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
1 participant
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.
Overview
Fixes #29187 by updating outdated configuration file documentation in the Podman man pages.
Instead of hardorcoding specific directory paths (which can quickly become outdated as configuration parsing rules change or expand), this update removes the hardcoded paths from the headings and text, pointing users directly to their respective manual pages for the complete source of truth.
Changes Made
docs/source/markdown/podman.1.md:containers.conf,mounts.conf,policy.json,registries.conf, andstorage.conf.containers.conf(5),containers-mounts.conf(5), etc.) for full override and path resolution details.docs/source/markdown/podman-image-trust.1.md.in:DESCRIPTIONsection to stop assuming/etc/containers/policy.jsonis the sole policy location.policy.jsonand a link tocontainers-policy.json(5)for exact system and user path handling.