From: Akira Yokosawa <akiyks@gmail.com>
To: Logan Gunthorpe <logang@deltatee.com>
Cc: corbet@lwn.net, hch@lst.de, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-next@vger.kernel.org,
sfr@canb.auug.org.au
Subject: Re: linux-next: build warning after merge of the dma-mapping tree
Date: Thu, 28 Jul 2022 11:23:34 +0900 [thread overview]
Message-ID: <8a3a24b5-1f2f-d2bd-f2c9-2bda9298e23c@gmail.com> (raw)
In-Reply-To: <838314fe-a85d-19be-71b6-264cad7e83c9@deltatee.com>
Hi,
On Wed, 27 Jul 2022 12:32:12 -0600, Logan Gunthorpe wrote:
> On 2022-07-27 05:48, Stephen Rothwell wrote:
>> Hi all,
>>
>> After merging the dma-mapping tree, today's linux-next build (htmldocs)
>> produced this warning:
>>
>> Documentation/driver-api/infrastructure:50: kernel/dma/mapping.c:258: WARNING: Option list ends without a blank line; unexpected unindent.
>>
>> Introduced by commit
>>
>> 7c2645a2a30a ("dma-mapping: allow EREMOTEIO return code for P2PDMA transfers")
>
>
> Oh, hmm, I thought I addressed this when I added the extra line at the
> end of the comment, but it seems the htmldocs is a bit fussier than that
> with the white space.
>
> The only way I can seem to suppress that error is by adding another tab
> character in the list; see below.
I think all you need is to see the reference at:
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#option-lists
There are examples for long options.
Thanks, Akira
>
> I'll send a full patch shortly.
>
> Logan
>
> --
>
> diff --git a/kernel/dma/mapping.c b/kernel/dma/mapping.c
> index 746d46825d08..99e1e0c9a295 100644
> --- a/kernel/dma/mapping.c
> +++ b/kernel/dma/mapping.c
> @@ -249,15 +249,15 @@ EXPORT_SYMBOL(dma_map_sg_attrs);
> * Returns 0 on success or a negative error code on error. The following
> * error codes are supported with the given meaning:
> *
> - * -EINVAL An invalid argument, unaligned access or other error
> - * in usage. Will not succeed if retried.
> - * -ENOMEM Insufficient resources (like memory or IOVA space) to
> - * complete the mapping. Should succeed if retried later.
> - * -EIO Legacy error code with an unknown meaning. eg. this is
> - * returned if a lower level call returned DMA_MAPPING_ERROR.
> - * -EREMOTEIO The DMA device cannot access P2PDMA memory specified in
> - * the sg_table. This will not succeed if retried.
> - *
> + * -EINVAL An invalid argument, unaligned access or other error
> + * in usage. Will not succeed if retried.
> + * -ENOMEM Insufficient resources (like memory or IOVA space) to
> + * complete the mapping. Should succeed if retried later.
> + * -EIO Legacy error code with an unknown meaning. eg. this is
> + * returned if a lower level call returned
> + * DMA_MAPPING_ERROR.
> + * -EREMOTEIO The DMA device cannot access P2PDMA memory specified
> + * in the sg_table. This will not succeed if retried.
> */
> int dma_map_sgtable(struct device *dev, struct sg_table *sgt,
> enum dma_data_direction dir, unsigned long attrs)
next prev parent reply other threads:[~2022-07-28 2:23 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-27 11:48 linux-next: build warning after merge of the dma-mapping tree Stephen Rothwell
2022-07-27 18:32 ` Logan Gunthorpe
2022-07-28 2:23 ` Akira Yokosawa [this message]
2022-07-28 8:57 ` Bagas Sanjaya
-- strict thread matches above, loose matches on Subject: below --
2021-08-18 22:54 Stephen Rothwell
2021-08-19 7:02 ` Christoph Hellwig
2021-08-13 7:11 Stephen Rothwell
2021-09-03 6:45 ` Stephen Rothwell
2021-09-06 12:41 ` Christoph Hellwig
2020-09-02 0:03 Stephen Rothwell
2020-09-02 15:25 ` Christoph Hellwig
2018-10-01 22:35 Stephen Rothwell
2018-10-02 14:22 ` Christoph Hellwig
2017-09-03 22:34 Stephen Rothwell
2017-09-04 5:51 ` Christoph Hellwig
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=8a3a24b5-1f2f-d2bd-f2c9-2bda9298e23c@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=hch@lst.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=logang@deltatee.com \
--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;
as well as URLs for NNTP newsgroup(s).