public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Fiona Ebner <f.ebner@proxmox.com>
To: Maximiliano Sandoval <m.sandoval@proxmox.com>,
	pve-devel@lists.proxmox.com
Subject: Re: [PATCH storage 1/1] cifs: match smbversion description with docs
Date: Mon, 24 Aug 2026 14:34:52 +0200	[thread overview]
Message-ID: <0945a4b6-a1dc-415a-88ab-0fe29d92968e@proxmox.com> (raw)
In-Reply-To: <20260226144316.451521-2-m.sandoval@proxmox.com>

The circular reference in the commit titles are not telling much. Please
use titles which better describe the changes.

Am 26.02.26 um 3:43 PM schrieb Maximiliano Sandoval:
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
>  src/PVE/Storage/CIFSPlugin.pm | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/src/PVE/Storage/CIFSPlugin.pm b/src/PVE/Storage/CIFSPlugin.pm
> index 54f0f4e..665ce1f 100644
> --- a/src/PVE/Storage/CIFSPlugin.pm
> +++ b/src/PVE/Storage/CIFSPlugin.pm
> @@ -147,9 +147,10 @@ sub properties {
>              maxLength => 256,
>          },
>          smbversion => {
> -            description =>
> -                "SMB protocol version. 'default' if not set, negotiates the highest SMB2+"
> -                . " version supported by both the client and server.",
> +            description => "SMB protocol version.",
> +            verbose_description => "SMB protocol version. When set to `default` or when unset,"
> +                . " negotiates the highest SMB2+ version supported by both the client and server."
> +                . " SMB1 is not supported due to security issues.",

While splitting description and verbose_description is sensible in
general, in case of 'man pvesm', this means that the verbose information
is not shown there anymore, which is not nice. So I held off from
applying this one. We should either make sure the verbose information is
shown there too (better solution) or just adapt the description.

>              type => 'string',
>              default => 'default',
>              enum => ['default', '2.0', '2.1', '3', '3.0', '3.11'],





  reply	other threads:[~2026-08-24 12:34 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-26 14:43 [PATCH docs/storage 0/2] docs: match smbdescription at pve-docs and pve-storage Maximiliano Sandoval
2026-02-26 14:43 ` [PATCH storage 1/1] cifs: match smbversion description with docs Maximiliano Sandoval
2026-08-24 12:34   ` Fiona Ebner [this message]
2026-02-26 14:43 ` [PATCH docs 1/1] docs: cifs: match smbversion docs with pve-storage Maximiliano Sandoval
2026-08-24 12:31   ` applied: " Fiona Ebner

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=0945a4b6-a1dc-415a-88ab-0fe29d92968e@proxmox.com \
    --to=f.ebner@proxmox.com \
    --cc=m.sandoval@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal