diff mbox series

[4/6] docs: i2c: index.rst: add slave-testunit-backend.rst

Message ID 2ac6bd9d96cc4ff248d1c2e26a99f51a785eb271.1601616399.git.mchehab+huawei@kernel.org
State Superseded
Headers show
Series Fix new html build warnings from next-20201001 | expand

Commit Message

Mauro Carvalho Chehab Oct. 2, 2020, 5:49 a.m. UTC
As warned by Sphinx:

	.../Documentation/i2c/slave-testunit-backend.rst: WARNING: document isn't included in any toctree

This document is not included anywhere.

Fixes: a8335c64c5f0 ("i2c: add slave testunit driver")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/hw-vuln/l1d_flush.rst | 3 +--
 Documentation/i2c/index.rst                     | 1 +
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Wolfram Sang Oct. 2, 2020, 7:54 a.m. UTC | #1
Hi Mauro,

> index 8a2ad3845191..9b8df313902c 100644
> --- a/Documentation/i2c/index.rst
> +++ b/Documentation/i2c/index.rst
> @@ -38,6 +38,7 @@ Debugging
>  
>     gpio-fault-injection
>     i2c-stub
> +   slave-testunit-backend

Yeah, it is missing, but this is the wrong paragraph to add it. For
consistency, I'd like to create a seperate patch to fix it and merge it
via I2C. Do you mind dropping this hunk? I'd credit you with
Reported-by, of course.

Thanks,

   Wolfram
Mauro Carvalho Chehab Oct. 2, 2020, 9:02 a.m. UTC | #2
Em Fri, 2 Oct 2020 09:54:04 +0200
Wolfram Sang <wsa@kernel.org> escreveu:

> Hi Mauro,
> 
> > index 8a2ad3845191..9b8df313902c 100644
> > --- a/Documentation/i2c/index.rst
> > +++ b/Documentation/i2c/index.rst
> > @@ -38,6 +38,7 @@ Debugging
> >  
> >     gpio-fault-injection
> >     i2c-stub
> > +   slave-testunit-backend  
> 
> Yeah, it is missing, but this is the wrong paragraph to add it. For
> consistency, I'd like to create a seperate patch to fix it and merge it
> via I2C. Do you mind dropping this hunk?

Yeah, sure!

> I'd credit you with
> Reported-by, of course.

Thanks,
Mauro
diff mbox series

Patch

diff --git a/Documentation/admin-guide/hw-vuln/l1d_flush.rst b/Documentation/admin-guide/hw-vuln/l1d_flush.rst
index adc4ecc72361..f794e2b1096c 100644
--- a/Documentation/admin-guide/hw-vuln/l1d_flush.rst
+++ b/Documentation/admin-guide/hw-vuln/l1d_flush.rst
@@ -22,8 +22,7 @@  mechanism
 Usage Guidelines
 ----------------
 
-Please see document: :ref:`Documentation/userspace-api/spec_ctrl.rst` for
-details.
+Please see document: :doc:`/userspace-api/spec_ctrl` for details.
 
 **NOTE**: The feature is disabled by default, applications need to
 specifically opt into the feature to enable it.
diff --git a/Documentation/i2c/index.rst b/Documentation/i2c/index.rst
index 8a2ad3845191..9b8df313902c 100644
--- a/Documentation/i2c/index.rst
+++ b/Documentation/i2c/index.rst
@@ -38,6 +38,7 @@  Debugging
 
    gpio-fault-injection
    i2c-stub
+   slave-testunit-backend
 
 Slave I2C
 =========