Re: [PATCH -next] Documentation: fix firewire.rst ABI file path error

Akira Yokosawa
2022-01-18T04:09:11Z

On Mon, 17 Jan 2022 17:05:17 -0800,
Randy Dunlap wrote:
> 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: /work/lnx/next/linux-next-20220117/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'.
>
> 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>
> ---
> I don't see what is causing this problem...

Randy, did you run "make SPHINXDIRS=driver-api htmldocs"?

I remember seeing similar errors with v5.14 or v5.15.
So I don't think this is a new issue.

Without "SPHINXDIRS=driver-api", I don't get this error on -next.

I didn't report it at the time as I was not sure it was expected
or not.

Thanks, Akira

>
> Documentation/driver-api/firewire.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20220117.orig/Documentation/driver-api/firewire.rst
> +++ linux-next-20220117/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