linux-kernel - [PATCH -next] libceph: fix doc warnings in cls_lock

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 10 Jun 2021 19:50:58 +0800
From:   Baokun Li <libaokun1@...wei.com>
To:     <idryomov@...il.com>, <jlayton@...nel.org>, <davem@...emloft.net>,
        <kuba@...nel.org>, <ceph-devel@...r.kernel.org>,
        <netdev@...r.kernel.org>, <linux-kernel@...r.kernel.org>
CC:     <weiyongjun1@...wei.com>, <yuehaibing@...wei.com>,
        <yangjihong1@...wei.com>, <yukuai3@...wei.com>,
        <libaokun1@...wei.com>
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 <libaokun1@...wei.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
-- 
2.31.1