From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 5CEA1B768 for ; Thu, 7 Apr 2022 12:05:48 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 538F134E1 for ; Thu, 7 Apr 2022 12:05:48 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 firstgate.proxmox.com (Proxmox) with ESMTPS id 225D034B1 for ; Thu, 7 Apr 2022 12:05:47 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id DCF9F463DC for ; Thu, 7 Apr 2022 12:05:46 +0200 (CEST) From: Fabian Ebner To: pve-devel@lists.proxmox.com Date: Thu, 7 Apr 2022 12:05:38 +0200 Message-Id: <20220407100543.130953-2-f.ebner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220407100543.130953-1-f.ebner@proxmox.com> References: <20220407100543.130953-1-f.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.107 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [resthandler.pm] Subject: [pve-devel] [PATCH v3 common 1/1] REST handler: get property description: escape curly braces for asciidoc X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 07 Apr 2022 10:05:48 -0000 Text enclosed in unescaped curly braces will be interpreted as an attribute reference breaking and e.g. lead to the description not showing up at all a generated man page further down the line. Signed-off-by: Fabian Ebner --- New in v3. Tried out various uses of curly braces and seems to work for man pages, HTML doc and API-viewer. src/PVE/RESTHandler.pm | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm index 4f1458b..c746181 100644 --- a/src/PVE/RESTHandler.pm +++ b/src/PVE/RESTHandler.pm @@ -517,6 +517,9 @@ my $get_property_description = sub { chomp $wdescr; $wdescr =~ s/^$/+/mg; + $wdescr =~ s/{/\\{/g; + $wdescr =~ s/}/\\}/g; + $res .= $wdescr . "\n"; if (my $req = $phash->{requires}) { -- 2.30.2