[PATCH docs/storage 0/2] docs: match smbdescription at pve-docs and pve-storage

[PATCH docs/storage 0/2] docs: match smbdescription at pve-docs and pve-storage

[Maximiliano Sandoval]

The documentation was misleading, we do not always default to 3. We also add the
note about SMB1 to pve-storage.


pve-storage:

Maximiliano Sandoval (1):
  cifs: match smbversion description with docs

 src/PVE/Storage/CIFSPlugin.pm | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)


pve-docs:

Maximiliano Sandoval (1):
  docs: cifs: match smbversion docs with pve-storage

 pve-storage-cifs.adoc | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)


Summary over all repositories:
  2 files changed, 7 insertions(+), 5 deletions(-)

-- 
Generated by murpp 0.9.0

[PATCH storage 1/1] cifs: match smbversion description with docs

[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.",
             type => 'string',
             default => 'default',
             enum => ['default', '2.0', '2.1', '3', '3.0', '3.11'],
-- 
2.47.3

Re: [PATCH storage 1/1] cifs: match smbversion description with docs

[Fiona Ebner]

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'],

[PATCH docs 1/1] docs: cifs: match smbversion docs with pve-storage

[Maximiliano Sandoval]

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 pve-storage-cifs.adoc | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/pve-storage-cifs.adoc b/pve-storage-cifs.adoc
index 6b8f35d..ef6bbe0 100644
--- a/pve-storage-cifs.adoc
+++ b/pve-storage-cifs.adoc
@@ -50,8 +50,9 @@ Sets the user domain (workgroup) for this storage. Optional.
 
 smbversion::
 
-SMB protocol Version. Optional, default is `3`.
-SMB1 is not supported due to security issues.
+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.
 
 path::
 
-- 
2.47.3

applied: [PATCH docs 1/1] docs: cifs: match smbversion docs with pve-storage

[Fiona Ebner]

On Thu, 26 Feb 2026 15:43:15 +0100, Maximiliano Sandoval wrote:
> 

Applied, thanks! I changed the commit title, added context to the
commit message and kept the explicit 'Optional' declaration.

[1/1] docs: cifs: fix description of default for 'smbversion' setting
      commit: b496391ed26fdadc519e5c8b90432f7801cf2c29