* [PATCH -next v2] Documentation: fix firewire.rst ABI file path error
@ 2022-01-19 3:39 Randy Dunlap
2022-01-21 0:01 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2022-01-19 3:39 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Jonathan Corbet, linux-doc, Stephen Rothwell,
Mauro Carvalho Chehab, Akira Yokosawa
Adjust the path of the ABI files for firewire.rst to prevent a
documentation build error. Prevents this problem:
Sphinx parallel build error:
docutils.utils.SystemMessage: Documentation/driver-api/firewire.rst:22: (SEVERE/4) Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '../Documentation/driver-api/ABI/stable/firewire-cdev'.
Fixes: 2f4830ef96d2 ("FireWire: add driver-api Introduction section")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tested-by: Akira Yokosawa <akiyks@gmail.com>
---
v2: Add Tested-by: and Fixes: from Akira (thanks!)
shorten path in error message;
Documentation/driver-api/firewire.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- linux-next-20220118.orig/Documentation/driver-api/firewire.rst
+++ linux-next-20220118/Documentation/driver-api/firewire.rst
@@ -19,7 +19,7 @@ of kernel interfaces is available via ex
Firewire char device data structures
====================================
-.. include:: /ABI/stable/firewire-cdev
+.. include:: ../ABI/stable/firewire-cdev
:literal:
.. kernel-doc:: include/uapi/linux/firewire-cdev.h
@@ -28,7 +28,7 @@ Firewire char device data structures
Firewire device probing and sysfs interfaces
============================================
-.. include:: /ABI/stable/sysfs-bus-firewire
+.. include:: ../ABI/stable/sysfs-bus-firewire
:literal:
.. kernel-doc:: drivers/firewire/core-device.c
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH -next v2] Documentation: fix firewire.rst ABI file path error
2022-01-19 3:39 [PATCH -next v2] Documentation: fix firewire.rst ABI file path error Randy Dunlap
@ 2022-01-21 0:01 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2022-01-21 0:01 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Randy Dunlap, linux-doc, Stephen Rothwell, Mauro Carvalho Chehab,
Akira Yokosawa
Randy Dunlap <rdunlap@infradead.org> writes:
> Adjust the path of the ABI files for firewire.rst to prevent a
> documentation build error. Prevents this problem:
>
> Sphinx parallel build error:
> docutils.utils.SystemMessage: Documentation/driver-api/firewire.rst:22: (SEVERE/4) Problems with "include" directive path:
> InputError: [Errno 2] No such file or directory: '../Documentation/driver-api/ABI/stable/firewire-cdev'.
>
> Fixes: 2f4830ef96d2 ("FireWire: add driver-api Introduction section")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Stephen Rothwell <sfr@canb.auug.org.au>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Tested-by: Akira Yokosawa <akiyks@gmail.com>
> ---
> v2: Add Tested-by: and Fixes: from Akira (thanks!)
> shorten path in error message;
>
> Documentation/driver-api/firewire.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-01-21 0:01 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-01-19 3:39 [PATCH -next v2] Documentation: fix firewire.rst ABI file path error Randy Dunlap
2022-01-21 0:01 ` Jonathan Corbet
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).