Re: [PATCH 30/32] Documentation: net: dsa: update configuration.rst reference

[Mauro Carvalho Chehab]

Em Thu, 1 Apr 2021 14:41:15 +0200
Andrew Lunn <andrew@xxxxxxx> escreveu:

> On Thu, Apr 01, 2021 at 02:17:50PM +0200, Mauro Carvalho Chehab wrote:
> > The file name: Documentation/configuration.txt
> > should be, instead: Documentation/networking/dsa/configuration.rst.
> > 
> > Update its cross-reference accordingly.
> > 
> > Fixes: 75b8988dfe83 ("cifsd: add server handler for central processing and tranport layers")
> > Fixes: 58dd7a8d9d02 ("Documentation: net: dsa: Describe DSA switch configuration")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> > ---
> >  Documentation/filesystems/cifs/cifsd.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/filesystems/cifs/cifsd.rst b/Documentation/filesystems/cifs/cifsd.rst
> > index 48ae58f2a53c..082a839535e7 100644
> > --- a/Documentation/filesystems/cifs/cifsd.rst
> > +++ b/Documentation/filesystems/cifs/cifsd.rst
> > @@ -114,7 +114,7 @@ How to run
> >  	# 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 Documentation/configuration.txt
> > +	- Refer smb.conf.example and Documentation/networking/dsa/configuration.rst
> >  	  in ksmbd-tools  
> 
> Hi Mauro
> 
> This looks wrong. There is no relationship between SMB and DSA. I
> suspect you are looking for some other configuration.txt

Thanks for reviewing it.

I'll drop the patch from my series.

After re-reading cifsd.rst, I suspect that it is actually trying to
refer to:

	https://github.com/cifsd-team/ksmbd-tools/blob/master/Documentation/configuration.txt

and not to a local file.

So, IMO, the right thing to do is to apply the enclosed patch instead.
	

Thanks,
Mauro

[PATCH] docs: cifsd: change the reference to configuration.txt

Changeset 75b8988dfe83 ("cifsd: add server handler for central processing and tranport layers")
added documentation for cifsd. There, it points to a file
named:
	Documentation/configuration.txt

This confuses Kernel scripts, as they think that this is a
document within the Kernel tree, instead of a file from
some other place.

Replace it by an hyperlink to the ksmbd-tools tree, in order
to avoid false-positives.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

diff --git a/Documentation/filesystems/cifs/cifsd.rst b/Documentation/filesystems/cifs/cifsd.rst
index 48ae58f2a53c..a6ab85e68252 100644
--- a/Documentation/filesystems/cifs/cifsd.rst
+++ b/Documentation/filesystems/cifs/cifsd.rst
@@ -114,8 +114,8 @@ How to run
 	# 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 Documentation/configuration.txt
-	  in ksmbd-tools
+	- Refer smb.conf.example and
+	  https://github.com/cifsd-team/ksmbd-tools/blob/master/Documentation/configuration.txt
 
 4. Insert ksmbd.ko module