[PATCH v2] ksmbd: update documentation

[PATCH v2] ksmbd: update documentation

[Namjae Jeon]

configuration.txt in ksmbd-tools moved to ksmb.conf manpage.
update it and more detailed ksmbd-tools build method.

Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>
---
 v2:
   - rename smb.conf to ksmbd.conf.
   - add how to set ksmbd module in menuconfig
   - remove --syscondir option for configure, instead change ksmbd
     directory to /usr/local/etc/ksmbd.
   - change the prompt to '$'.

 Documentation/filesystems/cifs/ksmbd.rst | 32 ++++++++++++++++--------
 1 file changed, 22 insertions(+), 10 deletions(-)

diff --git a/Documentation/filesystems/cifs/ksmbd.rst b/Documentation/filesystems/cifs/ksmbd.rst
index 1af600db2e70..69d4a4c3313b 100644
--- a/Documentation/filesystems/cifs/ksmbd.rst
+++ b/Documentation/filesystems/cifs/ksmbd.rst
@@ -118,24 +118,36 @@ ksmbd/nfsd interoperability    Planned for future. The features that ksmbd
 How to run
 ==========
 
-1. Download ksmbd-tools and compile them.
-	- https://github.com/cifsd-team/ksmbd-tools
+1. Download ksmbd-tools(https://github.com/cifsd-team/ksmbd-tools/releases) and compile them.
+   - Refer README(https://github.com/cifsd-team/ksmbd-tools/blob/master/README.md)
+     to know how to use ksmbd.<foo> utils
+
+     $ ./autogen.sh
+     $ ./configure --with-rundir=/run
+     $ make && sudo make install
 
 2. Create user/password for SMB share.
+   - See ksmbd.adduser manpage.
+
+     $ man ksmbd.adduser
+     $ sudo ksmbd.adduser -a <Enter USERNAME for SMB share access>
 
-	# mkdir /etc/ksmbd/
-	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
+3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in smb.conf file.
+   - Refer ksmbd.conf.example in ksmbd-utils, See ksmbd.conf manpage
+     for details to configure shares.
 
-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
+        $ man ksmbd.conf
 
-4. Insert ksmbd.ko module
+4. Insert ksmbd.ko module after build your kernel.
+   - Set ksmbd in menuconfig(e.g. $ make menuconfig)
+       [*] Network File Systems  --->
+           <M> SMB server support
 
-	# insmod ksmbd.ko
+	$ sudo insmod ksmbd.ko
 
 5. Start ksmbd user space daemon
-	# ksmbd.mountd
+
+	$ sudo ksmbd.mountd
 
 6. Access share from Windows or Linux using CIFS
 
-- 
2.25.1

Re: [PATCH v2] ksmbd: update documentation

[Sergey Senozhatsky]

On (22/09/06 10:58), Namjae Jeon wrote:
> 
> configuration.txt in ksmbd-tools moved to ksmb.conf manpage.
> update it and more detailed ksmbd-tools build method.
> 
> Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>

Reviewed-by: Sergey Senozhatsky <senozhatsky@chromium.org>

Re: [PATCH v2] ksmbd: update documentation

[Tom Talpey]

On 9/5/2022 9:58 PM, Namjae Jeon wrote:
> configuration.txt in ksmbd-tools moved to ksmb.conf manpage.
> update it and more detailed ksmbd-tools build method.
> 
> Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>
> ---
>   v2:
>     - rename smb.conf to ksmbd.conf.
>     - add how to set ksmbd module in menuconfig
>     - remove --syscondir option for configure, instead change ksmbd
>       directory to /usr/local/etc/ksmbd.
>     - change the prompt to '$'.
> 
>   Documentation/filesystems/cifs/ksmbd.rst | 32 ++++++++++++++++--------
>   1 file changed, 22 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/filesystems/cifs/ksmbd.rst b/Documentation/filesystems/cifs/ksmbd.rst
> index 1af600db2e70..69d4a4c3313b 100644
> --- a/Documentation/filesystems/cifs/ksmbd.rst
> +++ b/Documentation/filesystems/cifs/ksmbd.rst
> @@ -118,24 +118,36 @@ ksmbd/nfsd interoperability    Planned for future. The features that ksmbd
>   How to run
>   ==========
>   
> -1. Download ksmbd-tools and compile them.
> -	- https://github.com/cifsd-team/ksmbd-tools
> +1. Download ksmbd-tools(https://github.com/cifsd-team/ksmbd-tools/releases) and compile them.
> +   - Refer README(https://github.com/cifsd-team/ksmbd-tools/blob/master/README.md)
> +     to know how to use ksmbd.<foo> utils

I suggest typing out "<foo>" to include mountd, adduser and addshare.

> +
> +     $ ./autogen.sh
> +     $ ./configure --with-rundir=/run
> +     $ make && sudo make install
>   
>   2. Create user/password for SMB share.
> +   - See ksmbd.adduser manpage.
> +
> +     $ man ksmbd.adduser
> +     $ sudo ksmbd.adduser -a <Enter USERNAME for SMB share access>
>   
> -	# mkdir /etc/ksmbd/
> -	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in smb.conf file.

Typo - "ksmbd.conf" -------------------------------------------------^

Wouldn't the ksmbd.addshare command be a safer way to do this?

> +   - Refer ksmbd.conf.example in ksmbd-utils, See ksmbd.conf manpage
> +     for details to configure shares.

This way is fine too, but as an alternative for power users.

>   
> -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
> +        $ man ksmbd.conf
>   
> -4. Insert ksmbd.ko module
> +4. Insert ksmbd.ko module after build your kernel.

Can't ksmbd be built-in as well?

> +   - Set ksmbd in menuconfig(e.g. $ make menuconfig)
> +       [*] Network File Systems  --->
> +           <M> SMB server support
>   
> -	# insmod ksmbd.ko
> +	$ sudo insmod ksmbd.ko
>   
>   5. Start ksmbd user space daemon
> -	# ksmbd.mountd
> +
> +	$ sudo ksmbd.mountd
>   
>   6. Access share from Windows or Linux using CIFS

"SMB2 or SMB3" ----------------------------------^

Tom.

Re: [PATCH v2] ksmbd: update documentation

[Namjae Jeon]

2022-09-07 2:09 GMT+09:00, Tom Talpey <tom@talpey.com>:
> On 9/5/2022 9:58 PM, Namjae Jeon wrote:
>> configuration.txt in ksmbd-tools moved to ksmb.conf manpage.
>> update it and more detailed ksmbd-tools build method.
>>
>> Signed-off-by: Namjae Jeon <linkinjeon@kernel.org>
>> ---
>>   v2:
>>     - rename smb.conf to ksmbd.conf.
>>     - add how to set ksmbd module in menuconfig
>>     - remove --syscondir option for configure, instead change ksmbd
>>       directory to /usr/local/etc/ksmbd.
>>     - change the prompt to '$'.
>>
>>   Documentation/filesystems/cifs/ksmbd.rst | 32 ++++++++++++++++--------
>>   1 file changed, 22 insertions(+), 10 deletions(-)
>>
>> diff --git a/Documentation/filesystems/cifs/ksmbd.rst
>> b/Documentation/filesystems/cifs/ksmbd.rst
>> index 1af600db2e70..69d4a4c3313b 100644
>> --- a/Documentation/filesystems/cifs/ksmbd.rst
>> +++ b/Documentation/filesystems/cifs/ksmbd.rst
>> @@ -118,24 +118,36 @@ ksmbd/nfsd interoperability    Planned for future.
>> The features that ksmbd
>>   How to run
>>   ==========
>>
>> -1. Download ksmbd-tools and compile them.
>> -	- https://github.com/cifsd-team/ksmbd-tools
>> +1. Download
>> ksmbd-tools(https://github.com/cifsd-team/ksmbd-tools/releases) and
>> compile them.
>> +   - Refer
>> README(https://github.com/cifsd-team/ksmbd-tools/blob/master/README.md)
>> +     to know how to use ksmbd.<foo> utils
>
> I suggest typing out "<foo>" to include mountd, adduser and addshare.
Okay.
>
>> +
>> +     $ ./autogen.sh
>> +     $ ./configure --with-rundir=/run
>> +     $ make && sudo make install
>>
>>   2. Create user/password for SMB share.
>> +   - See ksmbd.adduser manpage.
>> +
>> +     $ man ksmbd.adduser
>> +     $ sudo ksmbd.adduser -a <Enter USERNAME for SMB share access>
>>
>> -	# mkdir /etc/ksmbd/
>> -	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in smb.conf
>> file.
>
> Typo - "ksmbd.conf" -------------------------------------------------^
Will fix it.
>
> Wouldn't the ksmbd.addshare command be a safer way to do this?
ksmbd.addshare can't update global section now. So I thought it seems
appropriate to edit ksmbd.conf directly in the initial running. If you
still need to add, please let me know.

>
>> +   - Refer ksmbd.conf.example in ksmbd-utils, See ksmbd.conf manpage
>> +     for details to configure shares.
>
> This way is fine too, but as an alternative for power users.
Okay, I understood that there is no more update and sound fine.
>
>>
>> -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
>> +        $ man ksmbd.conf
>>
>> -4. Insert ksmbd.ko module
>> +4. Insert ksmbd.ko module after build your kernel.
>
> Can't ksmbd be built-in as well?
Probably add this comment for this.
  4. Insert ksmbd.ko module (no need to load module if ksmbd is built
into the kernel)

>
>> +   - Set ksmbd in menuconfig(e.g. $ make menuconfig)
>> +       [*] Network File Systems  --->
>> +           <M> SMB server support
>>
>> -	# insmod ksmbd.ko
>> +	$ sudo insmod ksmbd.ko
>>
>>   5. Start ksmbd user space daemon
>> -	# ksmbd.mountd
>> +
>> +	$ sudo ksmbd.mountd
>>
>>   6. Access share from Windows or Linux using CIFS
>
> "SMB2 or SMB3" ----------------------------------^
Okay, Will update like this.
 SMB3 client (cifs.ko or smbclient of samba)

Thanks for your review!
>
> Tom.
>

Re: [PATCH v2] ksmbd: update documentation

[Tom Talpey]

On 9/6/2022 7:46 PM, Namjae Jeon wrote:
> 2022-09-07 2:09 GMT+09:00, Tom Talpey <tom@talpey.com>:
>> On 9/5/2022 9:58 PM, Namjae Jeon wrote:
>>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in smb.conf
>>> file.
>>
>> Typo - "ksmbd.conf" -------------------------------------------------^
> Will fix it.
>>
>> Wouldn't the ksmbd.addshare command be a safer way to do this?
> ksmbd.addshare can't update global section now. So I thought it seems
> appropriate to edit ksmbd.conf directly in the initial running. If you
> still need to add, please let me know.

I'm confused. If ksmbd.addshare can't add a share, what can it do?

Tom.

Re: [PATCH v2] ksmbd: update documentation

[Namjae Jeon]

2022-09-08 21:50 GMT+09:00, Tom Talpey <tom@talpey.com>:
> On 9/6/2022 7:46 PM, Namjae Jeon wrote:
>> 2022-09-07 2:09 GMT+09:00, Tom Talpey <tom@talpey.com>:
>>> On 9/5/2022 9:58 PM, Namjae Jeon wrote:
>>>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in
>>>> smb.conf
>>>> file.
>>>
>>> Typo - "ksmbd.conf" -------------------------------------------------^
>> Will fix it.
>>>
>>> Wouldn't the ksmbd.addshare command be a safer way to do this?
>> ksmbd.addshare can't update global section now. So I thought it seems
>> appropriate to edit ksmbd.conf directly in the initial running. If you
>> still need to add, please let me know.
>
> I'm confused. If ksmbd.addshare can't add a share, what can it do?
It can only add/delete/update the share section.

>
> Tom.
>

Re: [PATCH v2] ksmbd: update documentation

[Tom Talpey]

On 9/8/2022 10:28 AM, Namjae Jeon wrote:
> 2022-09-08 21:50 GMT+09:00, Tom Talpey <tom@talpey.com>:
>> On 9/6/2022 7:46 PM, Namjae Jeon wrote:
>>> 2022-09-07 2:09 GMT+09:00, Tom Talpey <tom@talpey.com>:
>>>> On 9/5/2022 9:58 PM, Namjae Jeon wrote:
>>>>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in
>>>>> smb.conf
>>>>> file.
>>>>
>>>> Typo - "ksmbd.conf" -------------------------------------------------^
>>> Will fix it.
>>>>
>>>> Wouldn't the ksmbd.addshare command be a safer way to do this?
>>> ksmbd.addshare can't update global section now. So I thought it seems
>>> appropriate to edit ksmbd.conf directly in the initial running. If you
>>> still need to add, please let me know.
>>
>> I'm confused. If ksmbd.addshare can't add a share, what can it do?
> It can only add/delete/update the share section.

I still don't get it. A share section is just a section that starts
with [foo] where "foo" is not "global", right? And if ksmbd.addshare
can add one, why can't it be used in the example?

Tom.

Re: [PATCH v2] ksmbd: update documentation

[Namjae Jeon]

2022-09-09 5:39 GMT+09:00, Tom Talpey <tom@talpey.com>:
> On 9/8/2022 10:28 AM, Namjae Jeon wrote:
>> 2022-09-08 21:50 GMT+09:00, Tom Talpey <tom@talpey.com>:
>>> On 9/6/2022 7:46 PM, Namjae Jeon wrote:
>>>> 2022-09-07 2:09 GMT+09:00, Tom Talpey <tom@talpey.com>:
>>>>> On 9/5/2022 9:58 PM, Namjae Jeon wrote:
>>>>>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in
>>>>>> smb.conf
>>>>>> file.
>>>>>
>>>>> Typo - "ksmbd.conf" -------------------------------------------------^
>>>> Will fix it.
>>>>>
>>>>> Wouldn't the ksmbd.addshare command be a safer way to do this?
>>>> ksmbd.addshare can't update global section now. So I thought it seems
>>>> appropriate to edit ksmbd.conf directly in the initial running. If you
>>>> still need to add, please let me know.
>>>
>>> I'm confused. If ksmbd.addshare can't add a share, what can it do?
>> It can only add/delete/update the share section.
>
> I still don't get it. A share section is just a section that starts
> with [foo] where "foo" is not "global", right? And if ksmbd.addshare
> can add one, why can't it be used in the example?
What I'm trying to say is that users who see this how to run section
are new to ksmbd. And ksmbd.addshare is created to add the share while
ksmbd is running with smb.conf already configured. For initial
setting, smb.conf including global section should be edited, but
guiding the use of ksmbd.addshare that cannot add global seciton may
cause confusion.
>
> Tom.
>