2021-06-10 11:44:11

by Baokun Li

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

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 <[email protected]>
---
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
--
2.31.1

2021-06-14 17:19:38

by Ilya Dryomov

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

On Thu, Jun 10, 2021 at 1:41 PM Baokun Li <[email protected]> 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 <[email protected]>
> ---
> 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