Skip to contentSkip to conversation

libceph: fix doc warnings in cls_lock_client.c

PATCH In review Baokun Li 2 participants 2 messages Jun 10, 2021 – Jun 14, 2021

Subsystems (3)
lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 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'

---
 net/ceph/cls_lock_client.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
net/ceph/cls_lock_client.c +9 -3
index 17447c19d937..82b7f3e3862f 100644
@@ -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
Signature · 1 line
2.31.1
maintainer
#1 lore raw
Quoted 56 lines · Baokun Li

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'

---
 net/ceph/cls_lock_client.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
net/ceph/cls_lock_client.c +6 -2
index 17447c19d937..82b7f3e3862f 100644
@@ -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
  */

net/ceph/cls_lock_client.c EXPORT_SYMBOL(ceph_cls_unlock); · line 142

Quoted 10 lines
net/ceph/cls_lock_client.c +3 -1
@@ -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