all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Christoph Heiss <c.heiss@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH common/docs 0/5] fix #6656: add clickable anchors for cli subcommands
Date: Tue, 12 Aug 2025 11:56:24 +0200	[thread overview]
Message-ID: <20250812095637.444463-1-c.heiss@proxmox.com> (raw)

Fixes #6656 [0], much like they already exist for section titles.

First changes the synopsis generation to also add an anchor to each
subcommand, then in pve-docs adds the required `a` element to all
paragraphs with an `id` set.

Patch #1 & #2 are just two small cleanups, actual implementation see 
patches #3 & #4.

[0] https://bugzilla.proxmox.com/show_bug.cgi?id=6656

Diffstat
========

pve-common:

Christoph Heiss (3):
  gitignore: add rules for more build artifacts
  cli handler: drop unused subroutine
  fix #6656: cli handler: generate anchors for all (sub-)commands

 .gitignore             |  4 ++++
 src/PVE/CLIHandler.pm  | 14 ++++++--------
 src/PVE/RESTHandler.pm |  2 ++
 3 files changed, 12 insertions(+), 8 deletions(-)

pve-docs:

Christoph Heiss (2):
  fix #6656: asciidoc: add anchor links for paragraphs with ids
  update generated cli synopsis files

 asciidoc/pve-docs.css           |  3 +-
 asciidoc/pve-html.conf          |  7 +++--
 ha-manager.1-synopsis.adoc      | 23 ++++++++++++++
 pct.1-synopsis.adoc             | 40 ++++++++++++++++++++++++
 pve-firewall.8-synopsis.adoc    |  9 ++++++
 pve-ha-crm.8-synopsis.adoc      |  5 +++
 pve-ha-lrm.8-synopsis.adoc      |  5 +++
 pveam.1-synopsis.adoc           |  7 +++++
 pveceph.1-synopsis.adoc         | 33 ++++++++++++++++++++
 pvecm.1-synopsis.adoc           | 15 +++++++++
 pvedaemon.8-synopsis.adoc       |  6 ++++
 pvenode.1-synopsis.adoc         | 27 ++++++++++++++++
 pveproxy.8-synopsis.adoc        |  6 ++++
 pvescheduler.8-synopsis.adoc    |  6 ++++
 pvesh.1-synopsis.adoc           |  8 +++++
 pvesm.1-synopsis.adoc           | 28 +++++++++++++++++
 pvesr.1-synopsis.adoc           | 15 +++++++++
 pvestatd.8-synopsis.adoc        |  6 ++++
 pvesubscription.1-synopsis.adoc |  7 +++++
 pveum.1-synopsis.adoc           | 49 +++++++++++++++++++++++++++++
 qm.1-synopsis.adoc              | 55 +++++++++++++++++++++++++++++++++
 qmrestore.1-synopsis.adoc       |  2 ++
 spiceproxy.8-synopsis.adoc      |  6 ++++
 vzdump.1-synopsis.adoc          |  2 ++
 24 files changed, 367 insertions(+), 3 deletions(-)

-- 
2.50.1



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


             reply	other threads:[~2025-08-12  9:55 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-12  9:56 Christoph Heiss [this message]
2025-08-12  9:56 ` [pve-devel] [PATCH common 1/3] gitignore: add rules for more build artifacts Christoph Heiss
2025-09-05 18:45   ` [pve-devel] applied: " Thomas Lamprecht
2025-08-12  9:56 ` [pve-devel] [PATCH common 2/3] cli handler: drop unused subroutine Christoph Heiss
2025-09-05 18:45   ` [pve-devel] applied: " Thomas Lamprecht
2025-08-12  9:56 ` [pve-devel] [PATCH common 3/3] fix #6656: cli handler: generate anchors for all (sub-)commands Christoph Heiss
2025-09-05 18:45   ` [pve-devel] applied: " Thomas Lamprecht
2025-08-12  9:56 ` [pve-devel] [PATCH docs 4/5] fix #6656: asciidoc: add anchor links for paragraphs with ids Christoph Heiss
2025-09-05 19:06   ` [pve-devel] applied: " Thomas Lamprecht
2025-08-12  9:56 ` [pve-devel] [PATCH docs 5/5] update generated cli synopsis files Christoph Heiss
2025-09-05 19:06   ` Thomas Lamprecht

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=20250812095637.444463-1-c.heiss@proxmox.com \
    --to=c.heiss@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal