[pve-devel] [PATCH pve-docs v2] fix #4554: pve-docs: Fixed some style nits.

[pve-devel] [PATCH pve-docs v2] fix #4554: pve-docs: Fixed some style nits.

[Alexander Abraham]

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