Re: [PATCH 1/2] ksmbd: update documentation

[Tom Talpey <tom@talpey.com>]

BTW, I expected a "2/2" message, but never saw it. Was the
subject a typo?

Anyway, I have a couple of comments on the new file, which are from
going to 
https://github.com/cifsd-team/ksmbd-tools/blob/master/smb.conf.5ksmbd.in

It refers to "SMB1", but ksmbd removed that, right? And because the
SMB2 (and SMB3!) dialects don't make it optional, does the setting
still make sense? Either way, delete "SMB1" and don't restrict the
discussion to "SMB2":

\fBserver signing\fR (G)
This controls whether the client is allowed or required to use SMB1 and 
SMB2 signing.
With \fBserver signing = disabled\fR, SMB1 signing is not offered and 
\fBserver signing = auto\fR applies when negotiating SMB2.
With \fBserver signing = auto\fR, SMB1 signing is offered and SMB2 
signing is required.
With \fBserver signing = mandatory\fR, both SMB1 and SMB2 signing is 
required.


Also, most of the settings start with the words "This controls whether".
I find these words unnecessary, and by the third or fourth one, they
are super-redundant. Would you consider rewording them in a more
active way, for example:

\fBbind interfaces only\fR (G)
This controls whether to only bind to interfaces specified with 
\fBinterfaces\fR.

... could be:

\fBbind interfaces only\fR (G)
Only bind to the interfaces specified in the \fBinterfaces\fR setting.

Tom.


On 8/30/2022 10:17 AM, Namjae Jeon wrote:
> configuration.txt in ksmbd-tools moved to smb.conf(5ksmbd) manpage.
> update it and more detailed ksmbd-tools build method.
> 
> Cc: Tom Talpey <tom@talpey.com>
> Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>
> ---
>   Documentation/filesystems/cifs/ksmbd.rst | 10 ++++++++--
>   1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/filesystems/cifs/ksmbd.rst b/Documentation/filesystems/cifs/ksmbd.rst
> index 1af600db2e70..767e12d2045a 100644
> --- a/Documentation/filesystems/cifs/ksmbd.rst
> +++ b/Documentation/filesystems/cifs/ksmbd.rst
> @@ -121,20 +121,26 @@ How to run
>   1. Download ksmbd-tools and compile them.
>   	- https://github.com/cifsd-team/ksmbd-tools
>   
> +        # ./autogen.sh
> +        # ./configure --sysconfdir=/etc --with-rundir=/run
> +        # make & sudo make install
> +
>   2. Create user/password for SMB share.
>   
>   	# mkdir /etc/ksmbd/
>   	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
>   
>   3. Create /etc/ksmbd/smb.conf file, add SMB share in smb.conf file
> -	- Refer smb.conf.example and
> -          https://github.com/cifsd-team/ksmbd-tools/blob/master/Documentation/configuration.txt
> +	- Refer smb.conf.example, See smb.conf(5ksmbd) for details.
> +
> +        # man smb.conf.5ksmbd
>   
>   4. Insert ksmbd.ko module
>   
>   	# insmod ksmbd.ko
>   
>   5. Start ksmbd user space daemon
> +
>   	# ksmbd.mountd
>   
>   6. Access share from Windows or Linux using CIFS