Skip to contentSkip to conversation

Documentation: fix firewire.rst ABI file path error

PATCH Applied Randy Dunlap 2 participants 2 messages Jan 19, 2022 – Jan 21, 2022 Documentation

lore
Share & tools
lore

Randy Dunlap

author reviewer
#0 lore raw

PATCH v2 1/1 Documentation: fix firewire.rst ABI file path error

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")
Cc Jonathan Corbet <[email protected]>
Cc Stephen Rothwell <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>

---
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(-)
Documentation/driver-api/firewire.rst +2 -2
@@ -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
maintainer Applied
#1 lore raw
Quoted 14 lines · Randy Dunlap

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")
Cc Jonathan Corbet <[email protected]>
Cc Stephen Rothwell <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Quoted 6 lines

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