All of lore.kernel.org
 help / color / mirror / Atom feed
From: rd.dunlab@gmail.com
To: linux-rdma@vger.kernel.org
Cc: Doug Ledford <dledford@redhat.com>,
	Jason Gunthorpe <jgg@mellanox.com>,
	linux-doc@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH 07/12] infiniband: fix core/verbs.c kernel-doc notation
Date: Wed, 09 Oct 2019 20:52:46 -0700	[thread overview]
Message-ID: <20191010035240.011497492@gmail.com> (raw)
In-Reply-To: 20191010035239.532908118@gmail.com

[-- Attachment #1: 012-iband-core-verbs.patch --]
[-- Type: text/plain, Size: 1411 bytes --]

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(+)

--- 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.



  parent reply	other threads:[~2019-10-10  4:09 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-10  3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
2019-10-10  3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings rd.dunlab
2019-10-10  3:52 ` [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h " rd.dunlab
2019-10-10  3:52 ` [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
2019-10-22 17:52   ` Jason Gunthorpe
2019-10-22 19:51     ` Randy Dunlap
2019-10-23  7:26       ` Jani Nikula
2019-10-23 12:03       ` Dennis Dalessandro
2019-10-10  3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
2019-10-23 20:30   ` Bart Van Assche
2019-10-23 20:39     ` Randy Dunlap
2019-10-10  3:52 ` rd.dunlab [this message]
2019-10-10  3:52 ` [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c " rd.dunlab
2019-10-10  3:52 ` [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings rd.dunlab
2019-10-10  3:52 ` [PATCH 10/12] infiniband: fix core/ kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 11/12] infiniband: fix sw/rdmavt/ " rd.dunlab
2019-10-10  3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
2019-10-10 15:45   ` kbuild test robot
2019-10-10 15:45     ` kbuild test robot
2019-10-21 17:07     ` Jason Gunthorpe
2019-10-21 21:57       ` Randy Dunlap
2019-10-21 21:57         ` Randy Dunlap
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
2019-10-22 22:51   ` Max Gurtovoy
2019-10-23 11:54   ` Dennis Dalessandro
2019-10-23 14:39     ` Jason Gunthorpe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191010035240.011497492@gmail.com \
    --to=rd.dunlab@gmail.com \
    --cc=dledford@redhat.com \
    --cc=jgg@mellanox.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-rdma@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.