From: Alexander Abraham <a.abraham@proxmox.com>
To: pve-devel@lists.proxmox.com
Cc: Alexander Abraham <a.abraham@proxmox.com>
Subject: [pve-devel] [PATCH pve-docs] fix #4554: Elaborated on the purpose of different output formats
Date: Mon, 10 Feb 2025 11:30:20 +0100 [thread overview]
Message-ID: <20250210103020.27237-1-a.abraham@proxmox.com> (raw)
Elaborated on the intended differences between the output
formats "text" and "json" for the "--output-format" option
of the "pvesh" utility.
Signed-off-by: Alexander Abraham <a.abraham@proxmox.com>
---
output-format.adoc | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/output-format.adoc b/output-format.adoc
index b3eb3c4..cb846ee 100644
--- a/output-format.adoc
+++ b/output-format.adoc
@@ -8,9 +8,15 @@ 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-glanceable
+information in a human-readable format. The goal of the `json` output
+is that the output is parseable and processable by different tools.
+
+The `text` output format additionally transforms some values into
+human-readable text, for example:
- Unix epoch is displayed as ISO 8601 date string.
- Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`.
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next reply other threads:[~2025-02-10 10:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-10 10:30 Alexander Abraham [this message]
2025-02-10 10:44 ` Maximiliano Sandoval
2025-02-10 10:53 ` Roland privat via pve-devel
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=20250210103020.27237-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal