[CI:DOCS] man pages: document some --format options

[edsantiago]

Baby steps toward merging #14046: document Go format options
for podman events.

This is deliberately imperfect. I am not the right person
to document these. I am simply the person who is getting
a skeleton framework in place.

Signed-off-by: Ed Santiago [email protected]

man pages: document Go format values for podman-events

[rhatdan]

LGTM

[mheon]

/lgtm
/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: edsantiago, mheon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [edsantiago,mheon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mheon]

I kind of hate having to include things like "Details" in the output. I understand it's necessary for completion/testing, but it's not something anyone should ever use...

[edsantiago]

@mheon I hate it too... so I've made an experimental tweak to my xref script so it'll silently recognize this:

diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md
index dd62ef5a2..df08b7d14 100644
--- a/docs/source/markdown/podman-events.1.md
+++ b/docs/source/markdown/podman-events.1.md
@@ -99,7 +99,6 @@ Format the output to JSON Lines or using the given Go template.                                                                              
 |--------------------|-----------------------------------------------|
 | .Attributes        | created_at, _by, labels, and more (map[])     |
 | .ContainerExitCode | Exit code (int)                               |
-| .Details ...       | Internal structure, not actually useful       |
 | .HealthStatus      | Health Status (string)                        |
 | .ID                | Container ID (full 64-bit SHA)                |
 | .Image             | Name of image being run (string)              |
@@ -109,6 +108,8 @@ Format the output to JSON Lines or using the given Go template.                                                                            
 | .Time              | Event timestamp (string)                      |
 | .Type              | Event type (e.g., image, container, pod, ...) |
 
+[//]: # (.Details - INTERNAL)
+
 #### **--help**
 
 Print usage statement.

Based on this hint about comments in markdown. The man page is unaffected, there is no extra whitespace or noise that I can see. Likewise the html. User-friendlier, at the cost of dev-unfriendliness. WDYT?

[edsantiago]

Can't prevent it from showing up in autocomplete, though - so maybe it's better to document it as "please ignore" than to have people search in vain.