[07/12] infiniband: fix core/verbs.c kernel-doc notation
diff mbox series

Message ID 20191010035240.011497492@gmail.com
State Accepted
Delegated to: Jason Gunthorpe
Headers show
Series
  • infiniband kernel-doc fixes & driver-api/ chapter
Related show

Commit Message

Randy Dunlap Oct. 10, 2019, 3:52 a.m. UTC
Add missing function parameter descriptions:

../drivers/infiniband/core/verbs.c:257: warning: Function parameter or member 'flags' not described in '__ib_alloc_pd'
../drivers/infiniband/core/verbs.c:257: warning: Function parameter or member 'caller' not described in '__ib_alloc_pd'

Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
This leaves a few Sphinx format warnings:

../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.

 drivers/infiniband/core/verbs.c |    2 ++
 1 file changed, 2 insertions(+)

Patch
diff mbox series

--- linux-next-20191009.orig/drivers/infiniband/core/verbs.c
+++ linux-next-20191009/drivers/infiniband/core/verbs.c
@@ -244,6 +244,8 @@  EXPORT_SYMBOL(rdma_port_get_link_layer);
 /**
  * ib_alloc_pd - Allocates an unused protection domain.
  * @device: The device on which to allocate the protection domain.
+ * @flags: protection domain flags
+ * @caller: caller's build-time module name
  *
  * A protection domain object provides an association between QPs, shared
  * receive queues, address handles, memory regions, and memory windows.