mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH -next] Documentation: fix firewire.rst ABI file path error
Date: Mon, 17 Jan 2022 22:05:21 -0800	[thread overview]
Message-ID: <7f4e454c-5f79-7fd7-2866-8db682cc656b@infradead.org> (raw)
In-Reply-To: <dc527b05-2b65-cf88-c174-6fec6d458de4@gmail.com>



On 1/17/22 20:08, Akira Yokosawa wrote:
> 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"?

Yes.
Does that cause a problem when just "make htmldocs" does not?

thanks.

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

-- 
~Randy

  reply	other threads:[~2022-01-18  6:05 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-18  1:05 Randy Dunlap
2022-01-18  4:08 ` Akira Yokosawa
2022-01-18  6:05   ` Randy Dunlap [this message]
2022-01-18  6:30     ` Akira Yokosawa
2022-01-19  7:09       ` Takashi Sakamoto

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7f4e454c-5f79-7fd7-2866-8db682cc656b@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®