From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: mark gross <mgross@linux.intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Heinrich Schuchardt <xypron.glpk@gmx.de>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 04/29] docs: admin-guide: hw-vuln: avoid using ReST :doc:`foo` markup
Date: Wed, 16 Jun 2021 22:21:56 +0200 [thread overview]
Message-ID: <20210616222156.3727599d@coco.lan> (raw)
In-Reply-To: <20210616182128.GJ70758@linux.intel.com>
Em Wed, 16 Jun 2021 11:21:28 -0700
mark gross <mgross@linux.intel.com> 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@kernel.org/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@kernel.org>
> > ---
> > .../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
next prev parent reply other threads:[~2021-06-16 20:22 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-16 6:27 [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 01/29] docs: devices.rst: better reference documentation docs Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 02/29] docs: dev-tools: kunit: don't use a table for docs name Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 03/29] docs: admin-guide: pm: avoid using ReST :doc:`foo` markup Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 04/29] docs: admin-guide: hw-vuln: " Mauro Carvalho Chehab
2021-06-16 18:21 ` mark gross
2021-06-16 20:21 ` Mauro Carvalho Chehab [this message]
2021-06-16 6:27 ` [PATCH v2 05/29] docs: admin-guide: sysctl: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 06/29] docs: block: biodoc.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 07/29] docs: bpf: bpf_lsm.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 08/29] docs: core-api: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 09/29] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 10/29] docs: dev-tools: kunit: " Mauro Carvalho Chehab
2021-06-25 21:27 ` Brendan Higgins
2021-06-25 22:12 ` Jonathan Corbet
2021-06-16 6:27 ` [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 22:08 ` Rob Herring
2021-06-17 6:38 ` Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 12/29] docs: doc-guide: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 13/29] docs: driver-api: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 14/29] docs: driver-api: gpio: using-gpio.rst: " Mauro Carvalho Chehab
2021-06-25 10:37 ` Bartosz Golaszewski
2021-06-16 6:27 ` [PATCH v2 15/29] docs: driver-api: surface_aggregator: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 16/29] docs: driver-api: usb: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 17/29] docs: firmware-guide: acpi: " Mauro Carvalho Chehab
2021-06-16 6:55 ` Sakari Ailus
2021-06-16 6:27 ` [PATCH v2 18/29] docs: i2c: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 19/29] docs: kernel-hacking: hacking.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 20/29] docs: networking: devlink: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 21/29] docs: PCI: endpoint: pci-endpoint-cfs.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 22/29] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-16 14:17 ` Bjorn Helgaas
2021-06-16 6:27 ` [PATCH v2 23/29] docs: process: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 24/29] docs: security: landlock.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 25/29] docs: trace: coresight: coresight.rst: " Mauro Carvalho Chehab
2021-06-17 15:03 ` Mathieu Poirier
2021-06-16 6:27 ` [PATCH v2 26/29] docs: trace: ftrace.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 27/29] docs: userspace-api: landlock.rst: " Mauro Carvalho Chehab
2021-06-23 12:26 ` Mickaël Salaün
2021-06-16 6:27 ` [PATCH v2 28/29] docs: virt: kvm: s390-pv-boot.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 29/29] docs: x86: " Mauro Carvalho Chehab
2021-06-17 19:34 ` [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210616222156.3727599d@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mgross@linux.intel.com \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).