man-page xref: make nested-structure warnings fatal

Followup to: - containers#21060, where I added new struct checks (but did not make them fatal) - containers#21534, which added per-interface stats and a .Network field, but its documentation was slightly off Signed-off-by: Ed Santiago <[email protected]>
edsantiago · Feb 15, 2024 · c7537d1 · c7537d1
1 parent 1141946
commit c7537d1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/source/markdown/podman-stats.1.md.in b/docs/source/markdown/podman-stats.1.md.in
@@ -51,7 +51,7 @@ Valid placeholders for the Go template are listed below:
 | .MemUsageBytes      | Memory usage (IEC)                               |
 | .Name               | Container Name                                   |
 | .NetIO              | Network IO                                       |
-| .Network            | Network I/O, separated by network interface      |
+| .Network ...        | Network I/O, separated by network interface      |
 | .PerCPU             | CPU time consumed by all tasks [1]               |
 | .PIDs               | Number of PIDs                                   |
 | .PIDS               | Number of PIDs (yes, we know this is a dup)      |

diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
@@ -256,6 +256,7 @@ sub xref_by_help {
                     }
 
                     warn "$ME: 'podman @subcommand {{$k' $msg\n";
+                    ++$Errs;
                 }
             }
         }
-Original file line number
+Diff line change
@@ Expand Up / @@ -256,6 +256,7 @@ sub xref_by_help { @@
                         }
                         warn "$ME: 'podman @subcommand {{$k' $msg\n";
+                        ++$Errs;
                     }
                 }
             }
@@ Expand Down @@