Commit 255e636d authored Apr 14, 2020 by Mauro Carvalho Chehab Committed by Jason Gunthorpe Apr 14, 2020

IB: Fix some documentation warnings

Parsing verbs.c with kernel-doc produce some warnings:

	./drivers/infiniband/core/verbs.c:2579: WARNING: Unexpected indentation.
	./drivers/infiniband/core/verbs.c:2581: WARNING: Block quote ends without a blank line; unexpected unindent.
	./drivers/infiniband/core/verbs.c:2613: WARNING: Unexpected indentation.
	./drivers/infiniband/core/verbs.c:2579: WARNING: Unexpected indentation.
	./drivers/infiniband/core/verbs.c:2581: WARNING: Block quote ends without a blank line; unexpected unindent.
	./drivers/infiniband/core/verbs.c:2613: WARNING: Unexpected indentation.

Address them by adding an extra blank line and converting the parameters
on one of the arguments to a table.

Link: https://lore.kernel.org/r/4c5466d0f450c5a9952138150c3485740b37f9c5.1586881715.git.mchehab+huawei@kernel.org


Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jason Gunthorpe <jgg@mellanox.com>

parent 1587982e

drivers/infiniband/core/verbs.c

+5 −2

Original line number	Diff line number	Diff line
		@@ -2574,6 +2574,7 @@ EXPORT_SYMBOL(ib_map_mr_sg_pi);
		* @page_size: page vector desired page size
		*
		* Constraints:
		*
		* - The first sg element is allowed to have an offset.
		* - Each sg element must either be aligned to page_size or virtually
		* contiguous to the previous element. In case an sg element has a
		@@ -2607,10 +2608,12 @@ EXPORT_SYMBOL(ib_map_mr_sg);
		* @mr: memory region
		* @sgl: dma mapped scatterlist
		* @sg_nents: number of entries in sg
		* @sg_offset_p: IN: start offset in bytes into sg
		* OUT: offset in bytes for element n of the sg of the first
		* @sg_offset_p: ==== =======================================================
		* IN start offset in bytes into sg
		* OUT offset in bytes for element n of the sg of the first
		* byte that has not been processed where n is the return
		* value of this function.
		* ==== =======================================================
		* @set_page: driver page assignment function pointer
		*
		* Core service helper for drivers to convert the largest

Admin message