linux-kernel - RE: [PATCH 30/32] Documentation: net: dsa: update configuration.rst reference

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 2 Apr 2021 08:59:35 +0900
From:   "Namjae Jeon" <namjae.jeon@...sung.com>
To:     "'Mauro Carvalho Chehab'" <mchehab+huawei@...nel.org>,
        "'Andrew Lunn'" <andrew@...n.ch>
Cc:     "'Linux Doc Mailing List'" <linux-doc@...r.kernel.org>,
        "'David S. Miller'" <davem@...emloft.net>,
        "'Jonathan Corbet'" <corbet@....net>,
        "'Benedikt Spranger'" <b.spranger@...utronix.de>,
        "'Florian Fainelli'" <f.fainelli@...il.com>,
        "'Hyunchul Lee'" <hyc.lee@...il.com>,
        "'Ronnie Sahlberg'" <lsahlber@...hat.com>,
        "'Sergey Senozhatsky'" <sergey.senozhatsky@...il.com>,
        "'Steve French'" <stfrench@...rosoft.com>,
        <linux-kernel@...r.kernel.org>
Subject: RE: [PATCH 30/32] Documentation: net: dsa: update configuration.rst
 reference

> Em Thu, 1 Apr 2021 14:41:15 +0200
> Andrew Lunn <andrew@...n.ch> 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@...nel.org>
> > > ---
> > >  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://protect2.fireeye.com/v1/url?k=28e6ada6-777d956f-28e726e9-0cc47a336fae-
> 3420a4e980f3c5ac&q=1&e=68e90996-b225-48b8-88cd-a32b7a3d23b6&u=https%3A%2F%2Fgithub.com%2Fcifsd-
> team%2Fksmbd-tools%2Fblob%2Fmaster%2FDocumentation%2Fconfiguration.txt
> 
> and not to a local file.
> 
> So, IMO, the right thing to do is to apply the enclosed patch instead.
ksmbd is still in review stage. not yet merged into linus tree.
So please don't include it in your series. I will apply the patch below directly.

Thanks for your patch!
> 
> 
> 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@...nel.org>
> 
> 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://protect2.fireeye.com/v1/url?k=6eb727bd-312c1f74-6eb6acf2-0cc47a
> +336fae-b5ccd9ba5c41390c&q=1&e=68e90996-b225-48b8-88cd-a32b7a3d23b6&u=ht
> +tps%3A%2F%2Fgithub.com%2Fcifsd-team%2Fksmbd-tools%2Fblob%2Fmaster%2FDoc
> +umentation%2Fconfiguration.txt
> 
>  4. Insert ksmbd.ko module
> 
>