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 514971FF144 for ; Tue, 24 Feb 2026 17:21:21 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id EC5EF1175D; Tue, 24 Feb 2026 17:22:16 +0100 (CET) Mime-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Tue, 24 Feb 2026 17:22:12 +0100 Message-Id: Subject: Re: [PATH datacenter-manager 4/4] docs: add simple man page for pdmAtoB To: "Lukas Wagner" X-Mailer: aerc 0.20.0 References: <20260220144114.996538-1-l.wagner@proxmox.com> <20260220144114.996538-5-l.wagner@proxmox.com> In-Reply-To: <20260220144114.996538-5-l.wagner@proxmox.com> From: "Shannon Sterz" X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1771950116567 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.095 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 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: IJ2FNH3BTWLLCDCKGJ26ED4HLVG3YQHU X-Message-ID-Hash: IJ2FNH3BTWLLCDCKGJ26ED4HLVG3YQHU X-MailFrom: s.sterz@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 CC: pdm-devel@lists.proxmox.com 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: On Fri Feb 20, 2026 at 3:41 PM CET, Lukas Wagner wrote: > Mostly to silence the lintian warning complaining about the missing > page. The content was copied over from PBS and adapted. > this doesn't apply anymore due to [1] being applied for what i can tell. [1]: https://git.proxmox.com/?p=3Dproxmox-datacenter-manager.git;a=3Dcommit= ;h=3D5f5143f822ea2ee1fc72489c49c38c2e10952c90 > Signed-off-by: Lukas Wagner > --- > debian/proxmox-datacenter-manager.install | 1 + > docs/Makefile | 1 + > docs/conf.py | 1 + > docs/pdmAtoB/man1.rst | 16 ++++++++++++++++ > 4 files changed, 19 insertions(+) > create mode 100644 docs/pdmAtoB/man1.rst > > diff --git a/debian/proxmox-datacenter-manager.install b/debian/proxmox-d= atacenter-manager.install > index 499e07ff..3538440c 100644 > --- a/debian/proxmox-datacenter-manager.install > +++ b/debian/proxmox-datacenter-manager.install > @@ -14,6 +14,7 @@ usr/share/bash-completion/completions/pdmAtoB.bc > usr/share/bash-completion/completions/proxmox-datacenter-api.bc > usr/share/bash-completion/completions/proxmox-datacenter-manager-admin.b= c > usr/share/bash-completion/completions/proxmox-datacenter-privileged-api.= bc > +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 :=3D \ > config/views/config.rst \ > > MAN1_PAGES :=3D \ > + 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 =3D [ > ('proxmox-datacenter-api/man1', 'proxmox-datacenter-api', 'Proxmox D= atacenter Manager Public API Server', [author], 1), > ('proxmox-datacenter-privileged-api/man1', 'proxmox-datacenter-privi= leged-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-manage= r-admin', 'Command line tool for managing Proxmox Datacenter Manager hosts.= ', [author], 1), > ('proxmox-datacenter-manager-client/man1', 'proxmox-datacenter-manag= er-client', 'Command line tool for connecting and controlling the remotes a= nd 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..10f2e883 > --- /dev/null > +++ b/docs/pdmAtoB/man1.rst > @@ -0,0 +1,16 @@ > +:orphan: > + > + > +=3D=3D=3D=3D=3D=3D=3D > +pdmAtoB > +=3D=3D=3D=3D=3D=3D=3D > + > +Description > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +This tool will help you to detect common pitfalls and misconfiguration b= efore, nit: i know this is pre-existing but "This tool will help you detect" would be a bit cleaner imo. nit: and misconfiguration*s* > +and during the upgrade of a Proxmox Datacenter Manager system. Any failu= res or > +warnings must be addressed prior to the upgrade. If you suspect that a m= essage > +is a false positive, you have to make carefully sure that it really is. nit: maybe "you have to be careful when making sure that..." might parse a bit more easily but none of these are real blockers and should probably then also apply to pbs (and maybe pve, did not check there). > + > +.. include:: ../pdm-copyright.rst