Documentation: Examples after the first one are indented inappropriately

[ratijas]

Issue Description

Look at the podman push -h output:

Push an image to a specified destination
[...]
Usage:
  podman push [options] IMAGE [DESTINATION]

Examples:
  podman push imageID docker://registry.example.com/repository:tag
                podman push imageID oci-archive:/path/to/layout:image:tag

Options:

Note how the second example is way off to the right. Source code:

podman/cmd/podman/images/push.go

Lines 44 to 45 in 509e44a

	Example: `podman push imageID docker://registry.example.com/repository:tag
	podman push imageID oci-archive:/path/to/layout:image:tag`,

	// Command: podman push
	pushCmd = &cobra.Command{
		Use:               "push [options] IMAGE [DESTINATION]",
		// [...]
		Example: `podman push imageID docker://registry.example.com/repository:tag
		podman push imageID oci-archive:/path/to/layout:image:tag`,
	}

I suppose, the backticks string were meant to strip leading whitespaces, but they never actually behaved that way in Go?

This issue is present in many other commands, not just push!

Steps to reproduce the issue

Steps to reproduce the issue

1. podman push -h

Describe the results you received

Second example is indented.

Describe the results you expected

Second example should not be indented.

podman info output

version:
  APIVersion: 5.5.2
  Built: 1754604929
  BuiltTime: Fri Aug  8 01:15:29 2025
  GitCommit: e7d8226745ba07a64b7176a7f128e4ef53225a0e
  GoVersion: go1.24.5
  Os: linux
  OsArch: linux/amd64
  Version: 5.5.2

Podman in a container

No

Privileged Or Rootless

Rootless

Upstream Latest Release

No

Additional environment details

No response

Additional information

No response

[danishprakash]

Podman seems to override the default cobra template and adds two spaces before {{Examples}} but that means subsequent newlines must be prefixed with explicit 2-space prefixes for every command.

Backticks would render the text verbatim so in this case, the prefix is a tab instead of spaces, and hence the rendering mismatch. There seem to be a few other commands that also have this problem. Would you like to raise a PR fixing this?

[ratijas]

I don't know about cobra and template, but it sounds like a thing where all these issues can be fixed in one place.

[MayorFaj]

/assign

[MayorFaj]

Rather than fixing each command individually, I added a centralized indentExamples template function that normalizes all Example strings to exactly 2-space indentation, regardless of how the raw string literal is indented in source code. The function is registered via cobra.AddTemplateFunc and piped in the usage template ({{.Example | indentExamples}}).

This also means future contributors don't need to worry about matching indentation in their backtick strings, the template function handles it uniformly.

[ratijas]

simply the best