Commit Graph

12 Commits

Author SHA1 Message Date
Daniel J Walsh c5a71c4fdc
Apply suggestions from code review
Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2024-02-20 05:49:04 -05:00
Daniel J Walsh 22effe8d40
Fix up example description of podman-stats.1.md.in
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2024-02-19 15:01:47 -05:00
Ed Santiago c7537d1939 man-page xref: make nested-structure warnings fatal
Followup to:
  - #21060, where I added new struct checks (but did not make them fatal)

  - #21534, which added per-interface stats and a .Network field,
    but its documentation was slightly off

Signed-off-by: Ed Santiago <santiago@redhat.com>
2024-02-15 13:22:31 -07:00
Matt Heon 6e0decbe03 Send container stats over API on a per-interface basis
This mirrors how the Docker API handles things, allowing us to be
more compatible with Docker and more verbose on the Libpod API.
Stats are given as per network interface in the container, but
still aggregated for `podman stats` and `podman pod stats`
display (so the CLI does not change, only the Libpod and Compat
APIs).

Signed-off-by: Matt Heon <mheon@redhat.com>
2024-02-06 17:05:07 -05:00
Daniel J Walsh d3a49fdedb
Add information about --latest support on man pages
On Mac and Windows systems the --latest option is not supported
this PR mentions this fact in the examples section of the man page.
Also added documentation and consistency to the man pages examples
sections.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2024-01-23 07:28:40 -05:00
Joshua Beighton e1f3ae0d8d
Update podman-stats.1.md.in
Signed-off-by: Joshua Beighton <83010264+JoshuaBeighton@users.noreply.github.com>
2023-11-13 13:34:44 +00:00
Daniel J Walsh acbe7703f9
Update docs/source/markdown/podman-stats.1.md.in
Co-authored-by: Valentin Rothberg <vrothberg@redhat.com>
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2023-07-31 09:31:33 -04:00
Daniel J Walsh 630e7ba394
Improve the description of fields in podman-stats man page
Fixes: https://github.com/containers/podman/issues/15146

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2023-07-30 06:28:30 -04:00
Daniel J Walsh 32c2cea0f9
Remove future tense from man pages
Remove all will, would, could, should and use present tense.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2023-05-16 15:10:33 -04:00
Daniel J Walsh 7665bbc127
Remove 'you' from man pages
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-12-07 09:29:29 -05:00
Ed Santiago 7d1f688ff9 [CI:DOCS] man pages: document some --format options
Baby steps toward merging #14046: document a few of the Go format
command-line options.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-09-15 09:59:32 -06:00
Ed Santiago 9ba034293d Man pages: refactor common options: 2 stats opts
--no-reset and --no-stream, in podman-stats and pod-stats.

Very minor tweak to --no-stream to account for pods.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-09-15 05:17:25 -06:00