Skip to contentSkip to conversation

dma-mapping: Reformat comment to suppress htmldoc warning

PATCH Applied Logan Gunthorpe 2 participants 2 messages Jul 27, 2022 – Jul 28, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dma-mapping: Reformat comment to suppress htmldoc warning

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

---

 kernel/dma/mapping.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
kernel/dma/mapping.c +9 -9
index a9ce5d728231..49cbf3e33de7 100644
@@ -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)

base-commit: 0d06132fc84bd91379300768c75a19474e06d0c5 --
2.30.2