2022-12-13 05:03:31

by Stephen Rothwell

[permalink] [raw]
Subject: linux-next: build warning after merge of the net-next tree

Hi all,

After merging the net-next tree, today's linux-next build (htmldocs)
produced this warning:

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

Introduced by commit

9f63f96aac92 ("Documentation: devlink: add devlink documentation for the etas_es58x driver")

--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature

2022-12-13 05:27:10

by Vincent MAILHOL

[permalink] [raw]
Subject: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

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 <[email protected]>
---
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(+)

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
--
2.25.1

2022-12-13 08:39:09

by Marc Kleine-Budde

[permalink] [raw]
Subject: Re: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

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 <[email protected]>

Added to linux-can-next.

Thanks,
Marc

--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung West/Dortmund | Phone: +49-231-2826-924 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |


Attachments:
(No filename) (752.00 B)
signature.asc (499.00 B)
Download all attachments

2022-12-13 14:08:49

by Marc Kleine-Budde

[permalink] [raw]
Subject: Re: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

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 <[email protected]>

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

Marc

--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung West/Dortmund | Phone: +49-231-2826-924 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |


Attachments:
(No filename) (764.00 B)
signature.asc (499.00 B)
Download all attachments

2022-12-13 14:27:42

by Vincent MAILHOL

[permalink] [raw]
Subject: Re: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

On Tue. 13 Dec. 2022 at 22:39, Marc Kleine-Budde <[email protected]> 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 <[email protected]>
>
> 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

2022-12-14 02:00:59

by Jakub Kicinski

[permalink] [raw]
Subject: Re: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

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 <[email protected]>
>
> 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.

2022-12-14 09:08:24

by Marc Kleine-Budde

[permalink] [raw]
Subject: Re: [PATCH] Documentation: devlink: add missing toc entry for etas_es58x devlink doc

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 <[email protected]>
> >
> > 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

--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung West/Dortmund | Phone: +49-231-2826-924 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |


Attachments:
(No filename) (1.25 kB)
signature.asc (499.00 B)
Download all attachments