public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Michael Köppl" <m.koeppl@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH docs v4 1/8] asciidoc-pve: allow linking sections with get_help_link
Date: Fri,  5 Jun 2026 17:38:12 +0200	[thread overview]
Message-ID: <20260605153819.310048-2-m.koeppl@proxmox.com> (raw)
In-Reply-To: <20260605153819.310048-1-m.koeppl@proxmox.com>

scan_extjs_file previously only scanned for occurrences of onlineHelp.
Linking to specific sections of the documentation with get_help_link was
not possible without an accompanying onlineHelp entry. Extend the regex
to also match get_help_link('blockid') calls.

biome may reformat function calls across multiple lines, so a scan which
reads one line at a time would miss those occurrences. Switch from
reading the file line by line to reading the whole file and matching
globally. In addition, tolerate an optional trailing comma after the
blockid argument. Line numbers for die/warn messages are reconstructed
from the match offset since $. is no longer meaningful when matching
against the full buffer.

Signed-off-by: Michael Köppl <m.koeppl@proxmox.com>
---
Feedback very much welcome. I ran into this problem when biome started
formatting the get_help_link function calls to multiple lines.
Alternatively, I could've added a `biome-ignore format: ...` to the
affected lines in pve-manager, but since it looks like we're not
ignoring the rules anywhere, I chose to adapt the scan function. I
tested this on both onlineHelp links and get_help_link links.

 scripts/asciidoc-pve.in | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/scripts/asciidoc-pve.in b/scripts/asciidoc-pve.in
index d42ddbe9..12fde424 100644
--- a/scripts/asciidoc-pve.in
+++ b/scripts/asciidoc-pve.in
@@ -463,16 +463,17 @@ sub scan_extjs_file {
 
     debug("scan-extjs $filename");
 
-    while (defined(my $line = <$fh>)) {
-        if ($line =~ m/\s+onlineHelp:\s*[\'\"]([^{}\[\]\'\"]+)[\'\"]/) {
-            my $blockid = $1;
-            my $link = $fileinfo->{blockid_target}->{default}->{$blockid};
-            if (!(defined($link) || defined($online_help_links->{$blockid}))) {
-                die "undefined blockid '$blockid' ($filename, line $.)\n" if !$allow_missing;
-                warn "ignoring undefined blockid '$blockid' ($filename, line $.)\n";
-            }
-            $res_data->{$blockid} = 1;
+    my $content = do { local $/; <$fh> };
+
+    while ($content =~ m/(?|\s+onlineHelp:\s*[\'\"]([^{}\[\]\'\"]+)[\'\"]|\bget_help_link\(\s*[\'\"]([^{}\[\]\'\"]+)[\'\"]\s*,?\s*\))/g) {
+        my $blockid = $1;
+        my $line_no = 1 + (substr($content, 0, $-[0]) =~ tr/\n//);
+        my $link = $fileinfo->{blockid_target}->{default}->{$blockid};
+        if (!(defined($link) || defined($online_help_links->{$blockid}))) {
+            die "undefined blockid '$blockid' ($filename, line $line_no)\n" if !$allow_missing;
+            warn "ignoring undefined blockid '$blockid' ($filename, line $line_no)\n";
         }
+        $res_data->{$blockid} = 1;
     }
 }
 
-- 
2.47.3





  reply	other threads:[~2026-06-05 15:38 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-05 15:38 [PATCH cluster/docs/manager/widget-toolkit v4 0/8] add warning messages for high token timeouts in clusters Michael Köppl
2026-06-05 15:38 ` Michael Köppl [this message]
2026-06-05 15:38 ` [PATCH docs v4 2/8] pvecm: add info about warnings regarding token coefficient Michael Köppl
2026-06-05 15:38 ` [PATCH cluster v4 3/8] add functions to determine warning level for high token timeouts Michael Köppl
2026-06-05 15:38 ` [PATCH cluster v4 4/8] pvecm: warn users of high token timeouts when using status command Michael Köppl
2026-06-05 15:38 ` [PATCH cluster v4 5/8] api: join info: add totem timeout warning message and level Michael Köppl
2026-06-05 15:38 ` [PATCH widget-toolkit v4 6/8] add pmx-critical CSS class Michael Köppl
2026-06-05 15:38 ` [PATCH manager v4 7/8] ui: cluster info: move initialization of items to initComponent Michael Köppl
2026-06-05 15:38 ` [PATCH manager v4 8/8] ui: cluster info: display warnings from the join info endpoint Michael Köppl

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=20260605153819.310048-2-m.koeppl@proxmox.com \
    --to=m.koeppl@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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal