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")
--
Cheers,
Stephen Rothwell
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'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)
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)
On Thu, Jul 28, 2022 at 11:23:34AM +0900, Akira Yokosawa wrote:
> > 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.
>
Hi Akira,
I read the reference, and for the long option case, I see:
> --very-long-option A VMS-style option. Note the adjustment for
> the required two spaces.
>
> --an-even-longer-option
> The description can also start on the next line.
I interpreted that for the first case above, two spaces separator between
the first and second sentence of option description is required, right?
--
An old man doll... just what I always wanted! - Clara