Skip to content

Indent option explanations using definition lists (:)#2755

Open
herrenP wants to merge 3 commits intocontainers:mainfrom
herrenP:manpage-indent-fix
Open

Indent option explanations using definition lists (:)#2755
herrenP wants to merge 3 commits intocontainers:mainfrom
herrenP:manpage-indent-fix

Conversation

@herrenP
Copy link
Copy Markdown

@herrenP herrenP commented Nov 25, 2025

This will render fine when generating man page files and also when viewed in vscode using "Markdown Preview Enhanced" extension. The built-in preview does not support definition lists. Also, when users are browsing project files in Github and view any of the .md files they will show a colon in front of each explanation unfortunately.

Copy link
Copy Markdown
Contributor

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

https://github.com/containers/skopeo/blob/main/CONTRIBUTING.md#sign-your-prs please, we can’t really even look at PRs with unclear copyright status. Thanks!

@herrenP
Copy link
Copy Markdown
Author

herrenP commented Nov 26, 2025

https://github.com/containers/skopeo/blob/main/CONTRIBUTING.md#sign-your-prs please, we can’t really even look at PRs with unclear copyright status. Thanks!

Thanks for the reminder. I'll look into it later.

Copy link
Copy Markdown
Contributor

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

Thanks!

Comment thread docs/skopeo-list-tags.1.md Outdated
**--creds** _username[:password]_ for accessing the registry.
**--creds** _username[:password]_

: For accessing the registry
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.

Now that this is not on one line, please use “Credentials for accessing the registry”. Similarly the --…creds and …registry-token (“Bearer token …”) options in skopeo-sync.

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.

Four more instances in skopeo-sync, per git grep -i '^:[ \t]*For ' docs.

Comment thread docs/skopeo.1.md Outdated
Comment thread docs/skopeo-copy.1.md Outdated
@mtrmac
Copy link
Copy Markdown
Contributor

mtrmac commented Dec 1, 2025

Other reviewers: highlighting

Also, when users are browsing project files in Github and view any of the .md files they will show a colon in front of each explanation unfortunately.

@mtrmac mtrmac linked an issue Dec 1, 2025 that may be closed by this pull request
Comment thread docs/skopeo-inspect.1.md Outdated
Comment thread docs/skopeo-list-tags.1.md Outdated
**--creds** _username[:password]_ for accessing the registry.
**--creds** _username[:password]_

: For accessing the registry
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.

Four more instances in skopeo-sync, per git grep -i '^:[ \t]*For ' docs.

Copy link
Copy Markdown
Contributor

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

Thanks! Also #2755 (comment) please.

@TomSweeneyRedHat
Copy link
Copy Markdown
Member

LGTM
once @mtrmac 's last comment is addressed and you rebase.

Yikes, what a lot of changes. I hope you were able to do so with AI, or at least some kind of VI/Emacs macro

@packit-as-a-service
Copy link
Copy Markdown

Ephemeral COPR build failed. @containers/packit-build please check.

@herrenP
Copy link
Copy Markdown
Author

herrenP commented Jan 15, 2026

LGTM once @mtrmac 's last comment is addressed and you rebase.

Yikes, what a lot of changes. I hope you were able to do so with AI, or at least some kind of VI/Emacs macro

Oh, I thought I had already rebased. Really not used to the PR flow.

Regarding the mtrmac's comment. I thought that was a heads up for other reviewers. Is there something I need to do?

@TomSweeneyRedHat
Copy link
Copy Markdown
Member

@herrenP Ooops, ignore my request for tending to @mtrmac's comment. My GitHub window was showing an outdated comment there. I see that you have tended to it.

OK, then, just get the rebase done, and it should be GTG.

FWIW, it's likely someone came in and updated one or more of your files after you rebased last time. It sometimes gets to be an annoying loop of rebase, push, rebase, push, but it's necessary.

@herrenP
Copy link
Copy Markdown
Author

herrenP commented Jan 15, 2026

@herrenP Ooops, ignore my request for tending to @mtrmac's comment. My GitHub window was showing an outdated comment there. I see that you have tended to it.

OK, then, just get the rebase done, and it should be GTG.

FWIW, it's likely someone came in and updated one or more of your files after you rebased last time. It sometimes gets to be an annoying loop of rebase, push, rebase, push, but it's necessary.

Thanks! I'll see if I can find time tomorrow.

@github-actions
Copy link
Copy Markdown

A friendly reminder that this PR had no activity for 30 days.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Request: indent explanations for options in man pages

3 participants