From: Alexander Abraham <a.abraham@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-docs v2] fix #4554: pve-docs: Fixed some style nits.
Date: Tue, 13 May 2025 15:55:38 +0200 [thread overview]
Message-ID: <20250513135538.83155-1-a.abraham@proxmox.com> (raw)
In-Reply-To: <m.sandoval@proxmox.com>
These commit fixes some style nits, rephrases a
few things that were unclear and elboartes on
the different output formats that the "pvesh" command
offers.
Signed-off-by: Alexander Abraham <a.abraham@proxmox.com>
---
output-format.adoc | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/output-format.adoc b/output-format.adoc
index b3eb3c4..43f4914 100644
--- a/output-format.adoc
+++ b/output-format.adoc
@@ -8,16 +8,26 @@ FORMAT_OPTIONS
endif::manvolnum[]
It is possible to specify the output format using the
-`--output-format` parameter. The default format 'text' uses ASCII-art
-to draw nice borders around tables. It additionally transforms some
-values into human-readable text, for example:
+`--output-format` parameter. The default format, 'text', uses ASCII art
+to draw nice borders around tables. Different output formats, such as
+"text" or "json", provide different functionality for different use
+cases. The `text` output format is supposed to present
+easily-understandable information in a human-readable format.
+The goal of the `json` output is that the output is parsable and
+processable by different tools.
-- Unix epoch is displayed as ISO 8601 date string.
-- Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`.
+The `text` output format additionally transforms some values into
+human-readable text, for example:
+
+- Unix epoch is displayed as an ISO 8601 date string.
+- Durations are displayed as week/day/hour/minute/second count, e.g. `1d 5h`.
- Byte sizes value include units (`B`, `KiB`, `MiB`, `GiB`, `TiB`, `PiB`).
- Fractions are display as percentage, i.e. 1.0 is displayed as 100%.
You can also completely suppress output using option `--quiet`.
+The information displayed is only a subset of all available
+information.
+
include::output-format-opts.adoc[]
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
parent reply other threads:[~2025-05-13 13:55 UTC|newest]
Thread overview: expand[flat|nested] mbox.gz Atom feed
[parent not found: <m.sandoval@proxmox.com>]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250513135538.83155-1-a.abraham@proxmox.com \
--to=a.abraham@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox