diff mbox series

Documentation: devlink: add missing toc entry for etas_es58x devlink doc

Message ID 20221213051136.721887-1-mailhol.vincent@wanadoo.fr
State New
Headers
Series Documentation: devlink: add missing toc entry for etas_es58x devlink doc |

Commit Message

Vincent Mailhol Dec. 13, 2022, 5:11 a.m. UTC 
  toc entry is missing for etas_es58x devlink doc and triggers this warning:

  Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree

Add the missing toc entry.

Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
---
Hi, sorry for forgetting the toc. Right now, I do not have access to a
build environment to test the fix. Because the fix seems easy, I take
the risk to send it as-is.

Thank you.
---
 Documentation/networking/devlink/index.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Marc Kleine-Budde Dec. 13, 2022, 8:15 a.m. UTC | #1 
On 13.12.2022 14:11:36, Vincent Mailhol wrote:
> toc entry is missing for etas_es58x devlink doc and triggers this warning:
> 
>   Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree
> 
> Add the missing toc entry.
> 
> Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
> Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>

Added to linux-can-next.

Thanks,
Marc
Marc Kleine-Budde Dec. 13, 2022, 1:39 p.m. UTC | #2 
On 13.12.2022 14:11:36, Vincent Mailhol wrote:
> toc entry is missing for etas_es58x devlink doc and triggers this warning:
> 
>   Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree
> 
> Add the missing toc entry.
> 
> Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
> Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>

Added to linux-can-next + added Reported-bys.

Marc
Vincent Mailhol Dec. 13, 2022, 2:14 p.m. UTC | #3 
On Tue. 13 Dec. 2022 at 22:39, Marc Kleine-Budde <mkl@pengutronix.de> wrote:
> On 13.12.2022 14:11:36, Vincent Mailhol wrote:
> > toc entry is missing for etas_es58x devlink doc and triggers this warning:
> >
> >   Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree
> >
> > Add the missing toc entry.
> >
> > Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
> > Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
>
> Added to linux-can-next + added Reported-bys.

Thanks :)

FYI, I now have access to a build environment. I confirmed that this
patch fixes the warning.

Yours sincerely,
Vincent Mailhol
Jakub Kicinski Dec. 14, 2022, 1:23 a.m. UTC | #4 
On Tue, 13 Dec 2022 14:39:54 +0100 Marc Kleine-Budde wrote:
> On 13.12.2022 14:11:36, Vincent Mailhol wrote:
> > toc entry is missing for etas_es58x devlink doc and triggers this warning:
> > 
> >   Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree
> > 
> > Add the missing toc entry.
> > 
> > Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
> > Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>  
> 
> Added to linux-can-next + added Reported-bys.

To -next or not to -next, that is the question..

FWIW the code is now in Linus's tree, but IDK how you forward your
trees. We could also take this directly given the file being changed,
but up to you.
Marc Kleine-Budde Dec. 14, 2022, 8:16 a.m. UTC | #5 
On 13.12.2022 17:23:51, Jakub Kicinski wrote:
> On Tue, 13 Dec 2022 14:39:54 +0100 Marc Kleine-Budde wrote:
> > On 13.12.2022 14:11:36, Vincent Mailhol wrote:
> > > toc entry is missing for etas_es58x devlink doc and triggers this warning:
> > > 
> > >   Documentation/networking/devlink/etas_es58x.rst: WARNING: document isn't included in any toctree
> > > 
> > > Add the missing toc entry.
> > > 
> > > Fixes: 9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")
> > > Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>  
> > 
> > Added to linux-can-next + added Reported-bys.
> 
> To -next or not to -next, that is the question..

I missed the fact that net-next is closed and already merged to Linus's
tree. So this should go into net/master.

> FWIW the code is now in Linus's tree, but IDK how you forward your
> trees. We could also take this directly given the file being changed,
> but up to you.

Thanks for the heads up,
Marc
diff mbox series

Patch

diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 4b653d040627..fee4d3968309 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -50,6 +50,7 @@  parameters, info versions, and other features it supports.
    :maxdepth: 1
 
    bnxt
+   etas_es58x
    hns3
    ionic
    ice