diff mbox series

[net] Documentation: net: fix path to devlink-trap-netdevsim

Message ID 20191009190621.27131-1-jakub.kicinski@netronome.com
State Not Applicable
Delegated to: David Miller
Headers show
Series [net] Documentation: net: fix path to devlink-trap-netdevsim | expand

Commit Message

Jakub Kicinski Oct. 9, 2019, 7:06 p.m. UTC
make htmldocs complains:
Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim

make the path relative.

Fixes: 9e0874570488 ("Documentation: Add description of netdevsim traps")
Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Reviewed-by: Simon Horman <simon.horman@netronome.com>
---
 Documentation/networking/devlink-trap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ido Schimmel Oct. 9, 2019, 7:34 p.m. UTC | #1
On Wed, Oct 09, 2019 at 12:06:21PM -0700, Jakub Kicinski wrote:
> make htmldocs complains:
> Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim
> 
> make the path relative.
> 
> Fixes: 9e0874570488 ("Documentation: Add description of netdevsim traps")
> Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
> Reviewed-by: Simon Horman <simon.horman@netronome.com>

Reviewed-by: Ido Schimmel <idosch@mellanox.com>

Thanks for fixing Jakub.

FWIW, someone already sent a patch [1] for this, but now I see that it's
marked as "Not Applicable". Maybe the expectation was that it would go
via the documentation tree? I just checked and I don't see it there [2].

[1] https://patchwork.ozlabs.org/patch/1171361/
[2] git://git.lwn.net/linux.git
Jakub Kicinski Oct. 9, 2019, 9:53 p.m. UTC | #2
On Wed, 9 Oct 2019 22:34:13 +0300, Ido Schimmel wrote:
> On Wed, Oct 09, 2019 at 12:06:21PM -0700, Jakub Kicinski wrote:
> > make htmldocs complains:
> > Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim
> > 
> > make the path relative.
> > 
> > Fixes: 9e0874570488 ("Documentation: Add description of netdevsim traps")
> > Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
> > Reviewed-by: Simon Horman <simon.horman@netronome.com>  
> 
> Reviewed-by: Ido Schimmel <idosch@mellanox.com>
> 
> Thanks for fixing Jakub.
> 
> FWIW, someone already sent a patch [1] for this, but now I see that it's
> marked as "Not Applicable". Maybe the expectation was that it would go
> via the documentation tree? I just checked and I don't see it there [2].
> 
> [1] https://patchwork.ozlabs.org/patch/1171361/
> [2] git://git.lwn.net/linux.git

Ah, thanks for pointing that out! Looks like some of Jonathan are going
via doc tree :S 

I'll just apply that one then.
diff mbox series

Patch

diff --git a/Documentation/networking/devlink-trap.rst b/Documentation/networking/devlink-trap.rst
index 8e90a85f3bd5..70335c3ed3c3 100644
--- a/Documentation/networking/devlink-trap.rst
+++ b/Documentation/networking/devlink-trap.rst
@@ -172,7 +172,7 @@  help debug packet drops caused by these exceptions. The following list includes
 links to the description of driver-specific traps registered by various device
 drivers:
 
-  * :doc:`/devlink-trap-netdevsim`
+  * :doc:`./devlink-trap-netdevsim`
 
 Generic Packet Trap Groups
 ==========================