linux-block.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Philipp Reisner <philipp.reisner@linbit.com>,
	Lars Ellenberg <lars.ellenberg@linbit.com>,
	Jens Axboe <axboe@kernel.dk>,
	drbd-dev@lists.linbit.com, linux-block@vger.kernel.org
Subject: [PATCH 04/11] block: drbd: drbd_state: Fix some function documentation issues
Date: Fri, 12 Mar 2021 10:55:23 +0000	[thread overview]
Message-ID: <20210312105530.2219008-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20210312105530.2219008-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/block/drbd/drbd_state.c:913: warning: Function parameter or member 'connection' not described in 'is_valid_soft_transition'
 drivers/block/drbd/drbd_state.c:913: warning: Excess function parameter 'device' description in 'is_valid_soft_transition'
 drivers/block/drbd/drbd_state.c:1054: warning: Function parameter or member 'warn' not described in 'sanitize_state'
 drivers/block/drbd/drbd_state.c:1054: warning: Excess function parameter 'warn_sync_abort' description in 'sanitize_state'
 drivers/block/drbd/drbd_state.c:1703: warning: Function parameter or member 'state_change' not described in 'after_state_ch'

Cc: Philipp Reisner <philipp.reisner@linbit.com>
Cc: Lars Ellenberg <lars.ellenberg@linbit.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: drbd-dev@lists.linbit.com
Cc: linux-block@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/block/drbd/drbd_state.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/block/drbd/drbd_state.c b/drivers/block/drbd/drbd_state.c
index 0067d328f0b56..b8a27818ab3f8 100644
--- a/drivers/block/drbd/drbd_state.c
+++ b/drivers/block/drbd/drbd_state.c
@@ -904,9 +904,9 @@ is_valid_state(struct drbd_device *device, union drbd_state ns)
  * is_valid_soft_transition() - Returns an SS_ error code if the state transition is not possible
  * This function limits state transitions that may be declined by DRBD. I.e.
  * user requests (aka soft transitions).
- * @device:	DRBD device.
- * @ns:		new state.
  * @os:		old state.
+ * @ns:		new state.
+ * @connection:  DRBD connection.
  */
 static enum drbd_state_rv
 is_valid_soft_transition(union drbd_state os, union drbd_state ns, struct drbd_connection *connection)
@@ -1044,7 +1044,7 @@ static void print_sanitize_warnings(struct drbd_device *device, enum sanitize_st
  * @device:	DRBD device.
  * @os:		old state.
  * @ns:		new state.
- * @warn_sync_abort:
+ * @warn:	placeholder for returned state warning.
  *
  * When we loose connection, we have to set the state of the peers disk (pdsk)
  * to D_UNKNOWN. This rule and many more along those lines are in this function.
@@ -1696,6 +1696,7 @@ static bool lost_contact_to_peer_data(enum drbd_disk_state os, enum drbd_disk_st
  * @os:		old state.
  * @ns:		new state.
  * @flags:	Flags
+ * @state_change: state change to broadcast
  */
 static void after_state_ch(struct drbd_device *device, union drbd_state os,
 			   union drbd_state ns, enum chg_state_flags flags,
-- 
2.27.0


  parent reply	other threads:[~2021-03-12 10:56 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-12 10:55 [PATCH 00/11] Rid W=1 warnings from Block Lee Jones
2021-03-12 10:55 ` [PATCH 01/11] block: rsxx: core: Remove superfluous const qualifier Lee Jones
2021-04-06 20:59   ` Bart Van Assche
2021-03-12 10:55 ` [PATCH 02/11] block: drbd: drbd_interval: Demote some kernel-doc abuses and fix another header Lee Jones
2021-04-06 21:00   ` Bart Van Assche
2021-03-12 10:55 ` [PATCH 03/11] block: mtip32xx: mtip32xx: Mark debugging variable 'start' as __maybe_unused Lee Jones
2021-04-06 21:01   ` Bart Van Assche
2021-04-07  8:00     ` Lee Jones
2021-03-12 10:55 ` Lee Jones [this message]
2021-03-12 10:55 ` [PATCH 05/11] block: drbd: drbd_receiver: Demote non-conformant kernel-doc headers Lee Jones
2021-03-12 10:55 ` [PATCH 06/11] block: drbd: drbd_main: Remove duplicate field initialisation Lee Jones
2021-03-19 14:56   ` Arnd Bergmann
2021-03-12 10:55 ` [PATCH 07/11] block: drbd: drbd_nl: Make conversion to 'enum drbd_ret_code' explicit Lee Jones
2021-03-12 10:55 ` [PATCH 08/11] block: drbd: drbd_main: Fix a bunch of function documentation discrepancies Lee Jones
2021-03-12 10:55 ` [PATCH 09/11] block: drbd: drbd_receiver: Demote less than half complete kernel-doc header Lee Jones
2021-03-12 10:55 ` [PATCH 10/11] block: xen-blkfront: Demote kernel-doc abuses Lee Jones
2021-04-06  9:09   ` Roger Pau Monné
2021-03-12 10:55 ` [PATCH 11/11] block: drbd: drbd_nl: Demote half-complete kernel-doc headers Lee Jones
2021-03-30 13:21 ` [PATCH 00/11] Rid W=1 warnings from Block Lee Jones
2021-04-06  8:52   ` Lee Jones
2021-04-06 15:22 ` Jens Axboe
2021-04-06 15:32   ` Lee Jones

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=20210312105530.2219008-5-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=axboe@kernel.dk \
    --cc=drbd-dev@lists.linbit.com \
    --cc=lars.ellenberg@linbit.com \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=philipp.reisner@linbit.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).