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 D184F1FF173 for <inbox@lore.proxmox.com>; Mon, 10 Feb 2025 12:00:09 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 85A7C8C1A; Mon, 10 Feb 2025 12:00:04 +0100 (CET) Date: Mon, 10 Feb 2025 11:53:53 +0100 References: <s8objvagjlu.fsf@proxmox.com> In-Reply-To: <s8objvagjlu.fsf@proxmox.com> To: Proxmox VE development discussion <pve-devel@lists.proxmox.com> MIME-Version: 1.0 Message-ID: <mailman.157.1739185203.293.pve-devel@lists.proxmox.com> List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Post: <mailto:pve-devel@lists.proxmox.com> From: Roland privat via pve-devel <pve-devel@lists.proxmox.com> Precedence: list Cc: Roland privat <devzero@web.de>, Alexander Abraham <a.abraham@proxmox.com> X-Mailman-Version: 2.1.29 X-BeenThere: pve-devel@lists.proxmox.com List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> 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/> Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> Subject: Re: [pve-devel] [PATCH pve-docs] fix #4554: Elaborated on the purpose of different output formats Content-Type: multipart/mixed; boundary="===============5884544973180942133==" Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com> --===============5884544973180942133== Content-Type: message/rfc822 Content-Disposition: inline Return-Path: <devzero@web.de> X-Original-To: pve-devel@lists.proxmox.com Delivered-To: pve-devel@lists.proxmox.com Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 13BE6CB9C7 for <pve-devel@lists.proxmox.com>; Mon, 10 Feb 2025 12:00:03 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E695B8A32 for <pve-devel@lists.proxmox.com>; Mon, 10 Feb 2025 11:59:32 +0100 (CET) Received: from mout.web.de (mout.web.de [212.227.15.14]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (prime256v1) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for <pve-devel@lists.proxmox.com>; Mon, 10 Feb 2025 11:59:32 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=web.de; s=s29768273; t=1739185165; x=1739789965; i=devzero@web.de; bh=buMAB2m4bALFFoX45J2dDILo6PhzPJ2EKELwiLM0vxk=; h=X-UI-Sender-Class:Content-Type:Content-Transfer-Encoding:From: Mime-Version:Subject:Date:Message-Id:References:Cc:In-Reply-To:To: cc:content-transfer-encoding:content-type:date:from:message-id: mime-version:reply-to:subject:to; b=HEm5d88F4nTQYOvECATPxkWqe3lHBdq8B5JbZPXMqSeGBVGrbeTsxfBinZlcPUIV NGFw5Zw5CRp+mAkQ2B1fG4cLN4bSOLtNZnNlx0gtxnCj0ySRz1Hot1uLXmJVbrtKw ue6GQihT82vHXiEEf7/NBeTjchYM+3Xv05Ng+urdDZ7rWh391mVNDtcBDhcHQLxlb pXugQ4RiSpAbp/TO6QDOHrdTJR/y3ZoePjwkt5c+v08De0wrjce48btK6qDS5eP2y eytC1AcOkXlilAvCvBmtWMwJmL4aObltBtjdkeIjo5G/6NKB6omL1pDtxrxhzwJml 5GTaOjWThtmhuChGiw== X-UI-Sender-Class: 814a7b36-bfc1-4dae-8640-3722d8ec6cd6 Received: from smtpclient.apple ([2.243.98.82]) by smtp.web.de (mrweb006 [213.165.67.108]) with ESMTPSA (Nemesis) id 1M2xw0-1tgKxc0htE-009sSq; Mon, 10 Feb 2025 11:54:04 +0100 From: Roland privat <devzero@web.de> Mime-Version: 1.0 (1.0) Subject: Re: [pve-devel] [PATCH pve-docs] fix #4554: Elaborated on the purpose of different output formats Date: Mon, 10 Feb 2025 11:53:53 +0100 Message-Id: <8117A399-60F9-489F-B1E0-095DCF0F0631@web.de> References: <s8objvagjlu.fsf@proxmox.com> Cc: Alexander Abraham <a.abraham@proxmox.com> In-Reply-To: <s8objvagjlu.fsf@proxmox.com> To: Proxmox VE development discussion <pve-devel@lists.proxmox.com> X-Mailer: iPhone Mail (21G93) X-Provags-ID: V03:K1:NxPwF9cD9X4oqc+BYZ7nxAUn26LmbFG2iKCEp5uApvxSigV9sWt KQEcPqbu7mJN6sqDz3+fGzQSdo0GtXj3Pkx5AhgjigCiEl51D4RwoO/M0sh5tw1Ar1hWLiO 0YnkOAxsV+JpKC6+1MuAJFrJpU1u561E4l5wRFtJbw2kIfIPhrlknVtrr9fdaJyL+sUyNBk qydrVeIX9IYqeJnYtkMdA== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:WjsnXGygC68=;QpVmAFhdwoZ+/prGdWKgXGMDr6H L4nt08C9JnIoEBtULnKdqbQPmZlt0PNjgpxQ2PgHlppNJm8qBmWiDeaiFbfDfgV4A5G/sBNpr JwnRbHzXl6oim9SCMY9FpBBneUOE7NgdBKH8J6jnLJrcyfEOowJEgV278fCZhMGN9KFzybgCA e4oG09XBgmB9ijqU8+1MvPxwRHNbFf/wKvfx8tE5ESu3Kqjq8EPCmVIelX3hryaR9hRzZoZ6K joe5L9Wot81vboNvOigE42SwLzUwLaIsAzcNf+3gl5tOofIJa+4/PHOXd3/VHFV8Nxz46Z179 BHSOCjSLd4wXtQKtiTz1py/ly0oY1pIFDGYpLMQvcAv4qKB+Go2bcFMhgoFw5kyH/YVmIWgoE gbzo8dNd4Dfivukd+VIKyVsEFVrO2KeRd1w3enc9wMxvMzeYbDszy9QNLoHMvL1JlrZlRyYlm xKPmNbn2RSaFmFTgz9sk99ZZzb9cT5B/n7Eu52JMXB2sFvKPaFemRYLhBticgHXG8S5rvrdZh x9ZcmVGMIMVcCyaZ7KfA55O6cTRAjNSWsq9UZHnYyimMmtrA/XwCC1Kr/62w5H2lHGlxnSj6U Xx6aq/8mC+tr6hquIe+eHyipfGHHo2JMcj7ziplr7dOhs8jc6d6ctdno0ovQcLB0bJu8rQQh5 06RhmXp0cj4PLR9ixkVsIyUOkOg96sNnEYi7KnoarQOSBsoHYM9E6tVN0ZvG1aKTQruY4frYR jZcFH+eBRuvZY3ZLaJkzgtW+AYS7I6WXfCDMkAJRBmBEWeSGXbvMkdATQ9uCntK1VG+BEoDb4 Xkf+SxfJEpxEyYXJaE6tTo2nuL/kVzjKbsMnJj62KxJNC3WZT2glLpsaArE5UemT2gAhh+TU2 OjWbAst+3z50betwfT7WAB9qnepjGRy9Bb2NYTU6LewuIfnMbLDOR1RgxCoyGCOxzpRWKey+y 0BrkKCinT2k1VtSD4uK+k6kBu8039WNkca/5ru7FrldrmLusFozOKbVTA3TNsFHKhnIVcifrx 7KdQMS2Jum2txSIMj7zyNw9YeWoqlOqYHCpymSSfThtPKErT7eU/y+U8zP5hPqBb02I4MyLFI GBkem7W13ri2SFig+S/ek96Z7apVzaval1/1CvxbabbavAtOI0D7TwfGV6Hy/Op7ZHWFB0N3U SwvnWTCTjj/lDO6P2E85b7B6+uTCgUy22S+C0J62vycCyBhkgr2a4X/egupe/W2ZIT+/Wc6ST omIYsd5aUXTNuu4aUwu5PPPiwuFXcutLSkUhYN0avXSWmabCPvTyRtTxD/8fK4CcehHfKMmFw bu4IT5xOL6TkUdKccl1cMTmtSmVykE1JyNuG5R8vBspiBM9NCJZII1UJKvZM97blJ6KTRyyGO UkR/N0GsmJ/Te02uqBc8uM7R0rURhhuQt3YdDzPZV1TfjPBcuA52Y/BFRX X-SPAM-LEVEL: Spam detection results: 0 BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain DMARC_PASS -0.1 DMARC pass policy FREEMAIL_FROM 0.001 Sender email is commonly abused enduser mail provider HTML_MESSAGE 0.001 HTML included in message MIME_QP_LONG_LINE 0.001 Quoted-printable line longer than 76 chars POISEN_SPAM_PILL_4 0.1 random spam to be learned in bayes RCVD_IN_DNSWL_LOW -0.7 Sender listed at https://www.dnswl.org/, low trust RCVD_IN_MSPIKE_H5 -1 Excellent reputation (+5) RCVD_IN_MSPIKE_WL -0.01 Mailspike good senders SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Content-Filtered-By: Mailman/MimeDel 2.1.29 perhaps it would be useful to mention, that default output only prints a su= bset of the available information. also see https://bugzilla.proxmox.com/show_bug.cgi?id=3D4554 roland > Am 10.02.2025 um 11:50 schrieb Maximiliano Sandoval <m.sandoval@proxmox.co= m>: >=20 > =EF=BB=BF > Some small comments bellow. >=20 > Alexander Abraham <a.abraham@proxmox.com> writes: >=20 >> Elaborated on the intended differences between the output >> formats "text" and "json" for the "--output-format" option >> of the "pvesh" utility. >>=20 >> Signed-off-by: Alexander Abraham <a.abraham@proxmox.com> >> --- >> output-format.adoc | 12 +++++++++--- >> 1 file changed, 9 insertions(+), 3 deletions(-) >>=20 >> 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[] >>=20 >> 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= >=20 > I am not sure if glanceable is correct. I would suggest to rephrase this. >=20 >> +information in a human-readable format. The goal of the `json` output >> +is that the output is parseable and processable by different tools. >=20 > This should be "parsable". >=20 >> + >> +The `text` output format additionally transforms some values into >> +human-readable text, for example: >>=20 >> - Unix epoch is displayed as ISO 8601 date string. >=20 > "... as a ISO...". >=20 >> - Durations are displayed as week/day/hour/minute/second count, i.e `1d 5= h`. >=20 > "e.g." or "for example" are more appropriate here. >=20 >=20 > _______________________________________________ > pve-devel mailing list > pve-devel@lists.proxmox.com > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel >=20 --===============5884544973180942133== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel --===============5884544973180942133==--