Skip to content

docs: fix typo dns-option#6955

Merged
TomSweeneyRedHat merged 1 commit into
podman-container-tools:mainfrom
leonardomoreira00:bug/fix-doc-dns-option-flag
Jul 14, 2026
Merged

docs: fix typo dns-option#6955
TomSweeneyRedHat merged 1 commit into
podman-container-tools:mainfrom
leonardomoreira00:bug/fix-doc-dns-option-flag

Conversation

@leonardomoreira00

Copy link
Copy Markdown
Contributor

Signed-off-by: Leonardo Moreira leonardo.moreira.coutinho@gmail.com

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Fixes misnamed flags in the documentation of buildah from, buildah build and buildah run.
Also provides a more precise description for the options when executing buildah run

How to verify it

Which issue(s) this PR fixes:

Fixes #6954

Special notes for your reviewer:

None.

Does this PR introduce a user-facing change?

None.

@leonardomoreira00

leonardomoreira00 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

@nalind, I'm teaching myself Buildah and other container tools like crun, podman in the little free time I get these days (newborn at home). I’ve started by comparing the man‑page documentation with the actual code. I hope it’s okay if I open small documentation PRs whenever I come across something unclear or inconsistent.

Please let me know if small PRs like this end up causing any inconvenience. It is not my intention.

@nalind nalind 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.

LGTM, thanks!

@nalind

nalind commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

@nalind, I'm teaching myself Buildah and other container tools like crun, podman in the little free time I get these days (newborn at home). I’ve started by comparing the man‑page documentation with the actual code. I hope it’s okay if I open small documentation PRs whenever I come across something unclear or inconsistent.

I'll admit it did raise an eyebrow - usually if we don't catch things like this in the PR that adds the text to the man page, they only get caught when a maintainer is in there doing something else, but you've allayed my concerns. Thanks again, and congrats!

@nalind

nalind commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Looks like the commit validation test is getting confused by the commit log not putting a blank line between docs: fix typo dns-option and the Signed-off-by, treating them as one subject line that's been wrapped instead of a subject and a longer description.

Signed-off-by: Leonardo Moreira <leonardo.moreira.coutinho@gmail.com>
@leonardomoreira00
leonardomoreira00 force-pushed the bug/fix-doc-dns-option-flag branch from d87f766 to f488726 Compare July 13, 2026 19:08
@leonardomoreira00

This comment was marked as off-topic.

@TomSweeneyRedHat TomSweeneyRedHat 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.

LGTM
and nice Eagle Eye on this one.

@TomSweeneyRedHat

Copy link
Copy Markdown
Contributor

/lgtm

@TomSweeneyRedHat
TomSweeneyRedHat merged commit 5f52e38 into podman-container-tools:main Jul 14, 2026
20 checks passed
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.

docs: fix typo in the --dns-option flag

3 participants