Re: [PATH datacenter-manager 4/4] docs: add simple man page for pdmAtoB

["Shannon Sterz" <s.sterz@proxmox.com>]

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=proxmox-datacenter-manager.git;a=commit;h=5f5143f822ea2ee1fc72489c49c38c2e10952c90

> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>  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-datacenter-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.bc
>  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 := \
>  	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..10f2e883
> --- /dev/null
> +++ b/docs/pdmAtoB/man1.rst
> @@ -0,0 +1,16 @@
> +:orphan:
> +
> +
> +=======
> +pdmAtoB
> +=======
> +
> +Description
> +===========
> +
> +This tool will help you to detect common pitfalls and misconfiguration before,

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 failures or
> +warnings must be addressed prior to the upgrade. If you suspect that a message
> +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