Re: [PATCH v2 04/29] docs: admin-guide: hw-vuln: avoid using ReST :doc:`foo` markup

[Mauro Carvalho Chehab]

Em Wed, 16 Jun 2021 11:21:28 -0700
mark gross <mgross@xxxxxxxxxxxxxxx> escreveu:

> On Wed, Jun 16, 2021 at 08:27:19AM +0200, Mauro Carvalho Chehab wrote:
> > The :doc:`foo` tag is auto-generated via automarkup.py.  
> and that is not good why?

Patch 00 contains a little more info:

	https://lore.kernel.org/linux-doc/cover.1623824363.git.mchehab+huawei@xxxxxxxxxx/T/#t

Basically, some Kernel developers rely on editor features to jump directly
into other files. Using Documentation/foo.rst enable such features.

> 
> > So, use the filename at the sources, instead of :doc:`foo`.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> > ---
> >  .../hw-vuln/special-register-buffer-data-sampling.rst          | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> > index 3b1ce68d2456..966c9b3296ea 100644
> > --- a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> > +++ b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> > @@ -3,7 +3,8 @@
> >  SRBDS - Special Register Buffer Data Sampling
> >  =============================================
> >  
> > -SRBDS is a hardware vulnerability that allows MDS :doc:`mds` techniques to  
> I thought the point of :doc:`mds` was to insert a tag or link to the mds
> document.
> 
> > +SRBDS is a hardware vulnerability that allows MDS
> > +Documentation/admin-guide/hw-vuln/mds.rst techniques to  
> will this make a hyper-link in generated HTML docs?

It will still generate the same hyper-links in HTML, LaTeX and PDF outputs,
as the automarkup.py extension will convert Documentation/foo.rst into
doc:`foo`.


> 
> FWIW I'm ok with this change either way.  I just wanted to understand a little
> better.
> 
> --mark
> 
> >  infer values returned from special register accesses.  Special register
> >  accesses are accesses to off core registers.  According to Intel's evaluation,
> >  the special register reads that have a security expectation of privacy are
> > -- 
> > 2.31.1
> >   



Thanks,
Mauro