From: Fabian Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v3 common 1/1] REST handler: get property description: escape curly braces for asciidoc
Date: Thu, 7 Apr 2022 12:05:38 +0200 [thread overview]
Message-ID: <20220407100543.130953-2-f.ebner@proxmox.com> (raw)
In-Reply-To: <20220407100543.130953-1-f.ebner@proxmox.com>
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 <f.ebner@proxmox.com>
---
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
next prev parent reply other threads:[~2022-04-07 10:05 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-07 10:05 [pve-devel] [PATCH-SEREIES v3 common/guest-common/manager] add protected and notes-template parameters for vzdump Fabian Ebner
2022-04-07 10:05 ` Fabian Ebner [this message]
2022-04-27 8:49 ` [pve-devel] applied: [PATCH v3 common 1/1] REST handler: get property description: escape curly braces for asciidoc Thomas Lamprecht
2022-04-07 10:05 ` [pve-devel] [PATCH v3 guest-common 1/1] vzdump: schema: add 'notes-template' and 'protected' properties Fabian Ebner
2022-04-07 10:05 ` [pve-devel] [PATCH v3 manager 1/4] vzdump: support setting protected status Fabian Ebner
2022-04-07 10:05 ` [pve-devel] [PATCH v3 manager 2/4] partially close #438: vzdump: support setting notes-template Fabian Ebner
2022-04-07 10:05 ` [pve-devel] [PATCH v3 manager 3/4] ui: backup: allow setting protected and notes-template for manual backup Fabian Ebner
2022-04-07 10:05 ` [pve-devel] [PATCH v3 manager 4/4] close #438: ui: backup job: allow setting a notes-template for a job Fabian Ebner
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=20220407100543.130953-2-f.ebner@proxmox.com \
--to=f.ebner@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox