From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id CD1731FF173
	for <inbox@lore.proxmox.com>; Mon, 10 Feb 2025 11:50:10 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 7EBED882A;
	Mon, 10 Feb 2025 11:50:07 +0100 (CET)
References: <20250210103020.27237-1-a.abraham@proxmox.com>
User-agent: mu4e 1.10.8; emacs 29.4
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Date: Mon, 10 Feb 2025 11:44:34 +0100
In-reply-to: <20250210103020.27237-1-a.abraham@proxmox.com>
Message-ID: <s8objvagjlu.fsf@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.103 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: Re: [pve-devel] [PATCH pve-docs] fix #4554: Elaborated on the
 purpose of different output formats
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Cc: Alexander Abraham <a.abraham@proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>


Some small comments bellow.

Alexander Abraham <a.abraham@proxmox.com> writes:

> 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

I am not sure if glanceable is correct. I would suggest to rephrase this.

> +information in a human-readable format. The goal of the `json` output
> +is that the output is parseable and processable by different tools.

This should be "parsable".

> +
> +The `text` output format additionally transforms some values into
> +human-readable text, for example:
>
>  - Unix epoch is displayed as ISO 8601 date string.

"... as a ISO...".

>  - Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`.

"e.g." or "for example" are more appropriate here.


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel