Commit 49ece311 authored by Lee Jones's avatar Lee Jones Committed by Jens Axboe
Browse files

block: drbd: drbd_state: Fix some function documentation issues 



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: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210312105530.2219008-5-lee.jones@linaro.org


Signed-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent d0e0cb97

drivers/block/drbd/drbd_state.c

+4 −3
Original line number Diff line number Diff line
@@ -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,