From: Lukas Wagner <l.wagner@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [PATCH datacenter-manager v2 4/4] docs: add simple man page for pdmAtoB
Date: Wed, 25 Feb 2026 11:19:24 +0100 [thread overview]
Message-ID: <20260225101924.127647-5-l.wagner@proxmox.com> (raw)
In-Reply-To: <20260225101924.127647-1-l.wagner@proxmox.com>
Mostly to silence the lintian warning complaining about the missing
page. The content was copied over from PBS and adapted.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Shannon Sterz <s.sterz@proxmox.com>
Tested-by: Shannon Sterz <s.sterz@proxmox.com>
---
Notes:
Changes since v1:
- rebased
- slightly rephrased the pdmAtoB man page, thx @ Shannon
debian/proxmox-datacenter-manager.install | 1 +
docs/Makefile | 1 +
docs/conf.py | 1 +
docs/pdmAtoB/man1.rst | 17 +++++++++++++++++
4 files changed, 20 insertions(+)
create mode 100644 docs/pdmAtoB/man1.rst
diff --git a/debian/proxmox-datacenter-manager.install b/debian/proxmox-datacenter-manager.install
index 001d7272..fad3f4a4 100644
--- a/debian/proxmox-datacenter-manager.install
+++ b/debian/proxmox-datacenter-manager.install
@@ -12,6 +12,7 @@ usr/sbin/pdmAtoB
usr/sbin/proxmox-datacenter-manager-admin
usr/share/bash-completion/completions/pdmAtoB.bash
usr/share/bash-completion/completions/proxmox-datacenter-manager-admin.bash
+usr/share/man/man1/pdmAtoB.1
usr/share/man/man1/proxmox-datacenter-api.1
usr/share/man/man1/proxmox-datacenter-manager-admin.1
usr/share/man/man1/proxmox-datacenter-privileged-api.1
diff --git a/docs/Makefile b/docs/Makefile
index 0487c97e..faa633bc 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,6 +7,7 @@ GENERATED_SYNOPSIS := \
config/views/config.rst \
MAN1_PAGES := \
+ pdmAtoB.1 \
proxmox-datacenter-manager-admin.1 \
proxmox-datacenter-manager-client.1 \
proxmox-datacenter-api.1 \
diff --git a/docs/conf.py b/docs/conf.py
index 9de1d1da..39724ef3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -95,6 +95,7 @@ man_pages = [
('proxmox-datacenter-api/man1', 'proxmox-datacenter-api', 'Proxmox Datacenter Manager Public API Server', [author], 1),
('proxmox-datacenter-privileged-api/man1', 'proxmox-datacenter-privileged-api', 'Proxmox Datacenter Manager Privileged API Server', [author], 1),
# CLI
+ ('pdmAtoB/man1', 'pdmAtoB', 'Upgrade checker for Proxmox Datacenter Manager', [author], 1),
('proxmox-datacenter-manager-admin/man1', 'proxmox-datacenter-manager-admin', 'Command line tool for managing Proxmox Datacenter Manager hosts.', [author], 1),
('proxmox-datacenter-manager-client/man1', 'proxmox-datacenter-manager-client', 'Command line tool for connecting and controlling the remotes and resources of a Proxmox Datacenter Manager hosts.', [author], 1),
# configs
diff --git a/docs/pdmAtoB/man1.rst b/docs/pdmAtoB/man1.rst
new file mode 100644
index 00000000..04a6ff26
--- /dev/null
+++ b/docs/pdmAtoB/man1.rst
@@ -0,0 +1,17 @@
+:orphan:
+
+
+=======
+pdmAtoB
+=======
+
+Description
+===========
+
+This tool will help you detect common pitfalls and misconfigurations before and
+during the upgrade of a Proxmox Datacenter Manager system. Any failures or
+warnings must be addressed prior to the upgrade. If you suspect that a message
+is a false positive, utmost carefulness is advised when proceeding with the
+upgrade.
+
+.. include:: ../pdm-copyright.rst
--
2.47.3
next prev parent reply other threads:[~2026-02-25 10:19 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-25 10:19 [PATCH datacenter-manager v2 0/4] Fix or ignore lintian errors Lukas Wagner
2026-02-25 10:19 ` [PATCH datacenter-manager v2 1/4] debian: silence 'field-too-long Build-Depends' error Lukas Wagner
2026-02-25 10:19 ` [PATCH datacenter-manager v2 2/4] debian: add uses-dpkg-database-directly override for pdmAtoB Lukas Wagner
2026-02-25 10:19 ` [PATCH datacenter-manager v2 3/4] debian: add lintian-override allowing the banner service in getty.target Lukas Wagner
2026-02-25 10:19 ` Lukas Wagner [this message]
2026-02-25 10:54 ` applied-series: [PATCH datacenter-manager v2 0/4] Fix or ignore lintian errors Fabian Grünbichler
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=20260225101924.127647-5-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pdm-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.