From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 640A71FF13B for ; Wed, 25 Feb 2026 11:19:10 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id EC204334EC; Wed, 25 Feb 2026 11:20:04 +0100 (CET) From: Lukas Wagner 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 Message-ID: <20260225101924.127647-5-l.wagner@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260225101924.127647-1-l.wagner@proxmox.com> References: <20260225101924.127647-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1772014750598 X-SPAM-LEVEL: Spam detection results: 0 AWL -1.022 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 1.113 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.358 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.659 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: GQ3AQID6GJLWP63O2W5GZT7ZBGLLKCGG X-Message-ID-Hash: GQ3AQID6GJLWP63O2W5GZT7ZBGLLKCGG X-MailFrom: l.wagner@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Datacenter Manager development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: 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 Reviewed-by: Shannon Sterz Tested-by: Shannon Sterz --- 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