diff mbox series

[-next] libceph: fix doc warnings in cls_lock_client.c

Message ID 20210610115058.3779341-1-libaokun1@huawei.com (mailing list archive)
State New, archived
Headers show
Series [-next] libceph: fix doc warnings in cls_lock_client.c | expand

Commit Message

libaokun (A) June 10, 2021, 11:50 a.m. UTC
Add description to fixes the following W=1 kernel build warning(s):

 net/ceph/cls_lock_client.c:28: warning: Function parameter or
  member 'osdc' not described in 'ceph_cls_lock'
 net/ceph/cls_lock_client.c:28: warning: Function parameter or
  member 'oid' not described in 'ceph_cls_lock'
 net/ceph/cls_lock_client.c:28: warning: Function parameter or
  member 'oloc' not described in 'ceph_cls_lock'

 net/ceph/cls_lock_client.c:93: warning: Function parameter or
  member 'osdc' not described in 'ceph_cls_unlock'
 net/ceph/cls_lock_client.c:93: warning: Function parameter or
  member 'oid' not described in 'ceph_cls_unlock'
 net/ceph/cls_lock_client.c:93: warning: Function parameter or
  member 'oloc' not described in 'ceph_cls_unlock'

 net/ceph/cls_lock_client.c:143: warning: Function parameter or
  member 'osdc' not described in 'ceph_cls_break_lock'
 net/ceph/cls_lock_client.c:143: warning: Function parameter or
  member 'oid' not described in 'ceph_cls_break_lock'
 net/ceph/cls_lock_client.c:143: warning: Function parameter or
  member 'oloc' not described in 'ceph_cls_break_lock'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
---
 net/ceph/cls_lock_client.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

Comments

Ilya Dryomov June 14, 2021, 5:17 p.m. UTC | #1
On Thu, Jun 10, 2021 at 1:41 PM Baokun Li <libaokun1@huawei.com> wrote:
>
> Add description to fixes the following W=1 kernel build warning(s):
>
>  net/ceph/cls_lock_client.c:28: warning: Function parameter or
>   member 'osdc' not described in 'ceph_cls_lock'
>  net/ceph/cls_lock_client.c:28: warning: Function parameter or
>   member 'oid' not described in 'ceph_cls_lock'
>  net/ceph/cls_lock_client.c:28: warning: Function parameter or
>   member 'oloc' not described in 'ceph_cls_lock'
>
>  net/ceph/cls_lock_client.c:93: warning: Function parameter or
>   member 'osdc' not described in 'ceph_cls_unlock'
>  net/ceph/cls_lock_client.c:93: warning: Function parameter or
>   member 'oid' not described in 'ceph_cls_unlock'
>  net/ceph/cls_lock_client.c:93: warning: Function parameter or
>   member 'oloc' not described in 'ceph_cls_unlock'
>
>  net/ceph/cls_lock_client.c:143: warning: Function parameter or
>   member 'osdc' not described in 'ceph_cls_break_lock'
>  net/ceph/cls_lock_client.c:143: warning: Function parameter or
>   member 'oid' not described in 'ceph_cls_break_lock'
>  net/ceph/cls_lock_client.c:143: warning: Function parameter or
>   member 'oloc' not described in 'ceph_cls_break_lock'
>
> Signed-off-by: Baokun Li <libaokun1@huawei.com>
> ---
>  net/ceph/cls_lock_client.c | 12 +++++++++---
>  1 file changed, 9 insertions(+), 3 deletions(-)
>
> diff --git a/net/ceph/cls_lock_client.c b/net/ceph/cls_lock_client.c
> index 17447c19d937..82b7f3e3862f 100644
> --- a/net/ceph/cls_lock_client.c
> +++ b/net/ceph/cls_lock_client.c
> @@ -10,7 +10,9 @@
>
>  /**
>   * ceph_cls_lock - grab rados lock for object
> - * @oid, @oloc: object to lock
> + * @osdc: working on this ceph osd client
> + * @oid: object to lock
> + * @oloc: object to lock
>   * @lock_name: the name of the lock
>   * @type: lock type (CEPH_CLS_LOCK_EXCLUSIVE or CEPH_CLS_LOCK_SHARED)
>   * @cookie: user-defined identifier for this instance of the lock
> @@ -82,7 +84,9 @@ EXPORT_SYMBOL(ceph_cls_lock);
>
>  /**
>   * ceph_cls_unlock - release rados lock for object
> - * @oid, @oloc: object to lock
> + * @osdc: working on this ceph osd client
> + * @oid: object to lock
> + * @oloc: object to lock
>   * @lock_name: the name of the lock
>   * @cookie: user-defined identifier for this instance of the lock
>   */
> @@ -130,7 +134,9 @@ EXPORT_SYMBOL(ceph_cls_unlock);
>
>  /**
>   * ceph_cls_break_lock - release rados lock for object for specified client
> - * @oid, @oloc: object to lock
> + * @osdc: working on this ceph osd client
> + * @oid: object to lock
> + * @oloc: object to lock
>   * @lock_name: the name of the lock
>   * @cookie: user-defined identifier for this instance of the lock
>   * @locker: current lock owner

Applied with a minor tweak.

Thanks,

                Ilya
diff mbox series

Patch

diff --git a/net/ceph/cls_lock_client.c b/net/ceph/cls_lock_client.c
index 17447c19d937..82b7f3e3862f 100644
--- a/net/ceph/cls_lock_client.c
+++ b/net/ceph/cls_lock_client.c
@@ -10,7 +10,9 @@ 
 
 /**
  * ceph_cls_lock - grab rados lock for object
- * @oid, @oloc: object to lock
+ * @osdc: working on this ceph osd client
+ * @oid: object to lock
+ * @oloc: object to lock
  * @lock_name: the name of the lock
  * @type: lock type (CEPH_CLS_LOCK_EXCLUSIVE or CEPH_CLS_LOCK_SHARED)
  * @cookie: user-defined identifier for this instance of the lock
@@ -82,7 +84,9 @@  EXPORT_SYMBOL(ceph_cls_lock);
 
 /**
  * ceph_cls_unlock - release rados lock for object
- * @oid, @oloc: object to lock
+ * @osdc: working on this ceph osd client
+ * @oid: object to lock
+ * @oloc: object to lock
  * @lock_name: the name of the lock
  * @cookie: user-defined identifier for this instance of the lock
  */
@@ -130,7 +134,9 @@  EXPORT_SYMBOL(ceph_cls_unlock);
 
 /**
  * ceph_cls_break_lock - release rados lock for object for specified client
- * @oid, @oloc: object to lock
+ * @osdc: working on this ceph osd client
+ * @oid: object to lock
+ * @oloc: object to lock
  * @lock_name: the name of the lock
  * @cookie: user-defined identifier for this instance of the lock
  * @locker: current lock owner