dma-mapping: reformat comment to suppress htmldoc warning
authorLogan Gunthorpe <logang@deltatee.com>
Wed, 27 Jul 2022 19:15:22 +0000 (13:15 -0600)
committerChristoph Hellwig <hch@lst.de>
Thu, 28 Jul 2022 14:21:33 +0000 (07:21 -0700)
make html doc reports a cryptic warning with the commit named below:

  kernel/dma/mapping.c:258: WARNING: Option list ends without a blank
                                     line; unexpected unindent.

Seems the parser is a bit fussy about the tabbing and having a single
space tab causes the warning. To suppress the warning add another
tab to the list and reindent everything.

Fixes: 7c2645a2a30a ("dma-mapping: allow EREMOTEIO return code for P2PDMA transfers")
Signed-off-by: Logan Gunthorpe <logang@deltatee.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
kernel/dma/mapping.c

index a9ce5d7..49cbf3e 100644 (file)
@@ -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)