Commit 584164c8 authored by Lee Jones's avatar Lee Jones Committed by Jens Axboe

block: drbd: drbd_main: Fix a bunch of function documentation discrepancies

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

 drivers/block/drbd/drbd_main.c:278: warning: Function parameter or member 'connection' not described in 'tl_clear'
 drivers/block/drbd/drbd_main.c:278: warning: Excess function parameter 'device' description in 'tl_clear'
 drivers/block/drbd/drbd_main.c:489: warning: Function parameter or member 'cpu_mask' not described in 'drbd_calc_cpu_mask'
 drivers/block/drbd/drbd_main.c:528: warning: Excess function parameter 'device' description in 'drbd_thread_current_set_cpu'
 drivers/block/drbd/drbd_main.c:549: warning: Function parameter or member 'connection' not described in 'drbd_header_size'
 drivers/block/drbd/drbd_main.c:1204: warning: Function parameter or member 'device' not described in 'send_bitmap_rle_or_plain'
 drivers/block/drbd/drbd_main.c:1204: warning: Function parameter or member 'c' not described in 'send_bitmap_rle_or_plain'
 drivers/block/drbd/drbd_main.c:1335: warning: Function parameter or member 'peer_device' not described in '_drbd_send_ack'
 drivers/block/drbd/drbd_main.c:1335: warning: Excess function parameter 'device' description in '_drbd_send_ack'
 drivers/block/drbd/drbd_main.c:1379: warning: Function parameter or member 'peer_device' not described in 'drbd_send_ack'
 drivers/block/drbd/drbd_main.c:1379: warning: Excess function parameter 'device' description in 'drbd_send_ack'
 drivers/block/drbd/drbd_main.c:1892: warning: Function parameter or member 'connection' not described in 'drbd_send_all'
 drivers/block/drbd/drbd_main.c:1892: warning: Function parameter or member 'sock' not described in 'drbd_send_all'
 drivers/block/drbd/drbd_main.c:1892: warning: Function parameter or member 'buffer' not described in 'drbd_send_all'
 drivers/block/drbd/drbd_main.c:1892: warning: Function parameter or member 'size' not described in 'drbd_send_all'
 drivers/block/drbd/drbd_main.c:1892: warning: Function parameter or member 'msg_flags' not described in 'drbd_send_all'
 drivers/block/drbd/drbd_main.c:3525: warning: Function parameter or member 'flags' not described in 'drbd_queue_bitmap_io'
 drivers/block/drbd/drbd_main.c:3563: warning: Function parameter or member 'flags' not described in 'drbd_bitmap_io'

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-9-lee.jones@linaro.orgSigned-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent 1f1e87b4
...@@ -268,7 +268,7 @@ void tl_restart(struct drbd_connection *connection, enum drbd_req_event what) ...@@ -268,7 +268,7 @@ void tl_restart(struct drbd_connection *connection, enum drbd_req_event what)
/** /**
* tl_clear() - Clears all requests and &struct drbd_tl_epoch objects out of the TL * tl_clear() - Clears all requests and &struct drbd_tl_epoch objects out of the TL
* @device: DRBD device. * @connection: DRBD connection.
* *
* This is called after the connection to the peer was lost. The storage covered * This is called after the connection to the peer was lost. The storage covered
* by the requests on the transfer gets marked as our of sync. Called from the * by the requests on the transfer gets marked as our of sync. Called from the
...@@ -479,7 +479,7 @@ int conn_lowest_minor(struct drbd_connection *connection) ...@@ -479,7 +479,7 @@ int conn_lowest_minor(struct drbd_connection *connection)
} }
#ifdef CONFIG_SMP #ifdef CONFIG_SMP
/** /*
* drbd_calc_cpu_mask() - Generate CPU masks, spread over all CPUs * drbd_calc_cpu_mask() - Generate CPU masks, spread over all CPUs
* *
* Forces all threads of a resource onto the same CPU. This is beneficial for * Forces all threads of a resource onto the same CPU. This is beneficial for
...@@ -518,7 +518,6 @@ static void drbd_calc_cpu_mask(cpumask_var_t *cpu_mask) ...@@ -518,7 +518,6 @@ static void drbd_calc_cpu_mask(cpumask_var_t *cpu_mask)
/** /**
* drbd_thread_current_set_cpu() - modifies the cpu mask of the _current_ thread * drbd_thread_current_set_cpu() - modifies the cpu mask of the _current_ thread
* @device: DRBD device.
* @thi: drbd_thread object * @thi: drbd_thread object
* *
* call in the "main loop" of _all_ threads, no need for any mutex, current won't die * call in the "main loop" of _all_ threads, no need for any mutex, current won't die
...@@ -538,7 +537,7 @@ void drbd_thread_current_set_cpu(struct drbd_thread *thi) ...@@ -538,7 +537,7 @@ void drbd_thread_current_set_cpu(struct drbd_thread *thi)
#define drbd_calc_cpu_mask(A) ({}) #define drbd_calc_cpu_mask(A) ({})
#endif #endif
/** /*
* drbd_header_size - size of a packet header * drbd_header_size - size of a packet header
* *
* The header size is a multiple of 8, so any payload following the header is * The header size is a multiple of 8, so any payload following the header is
...@@ -1193,7 +1192,7 @@ static int fill_bitmap_rle_bits(struct drbd_device *device, ...@@ -1193,7 +1192,7 @@ static int fill_bitmap_rle_bits(struct drbd_device *device,
return len; return len;
} }
/** /*
* send_bitmap_rle_or_plain * send_bitmap_rle_or_plain
* *
* Return 0 when done, 1 when another iteration is needed, and a negative error * Return 0 when done, 1 when another iteration is needed, and a negative error
...@@ -1324,7 +1323,7 @@ void drbd_send_b_ack(struct drbd_connection *connection, u32 barrier_nr, u32 set ...@@ -1324,7 +1323,7 @@ void drbd_send_b_ack(struct drbd_connection *connection, u32 barrier_nr, u32 set
/** /**
* _drbd_send_ack() - Sends an ack packet * _drbd_send_ack() - Sends an ack packet
* @device: DRBD device. * @peer_device: DRBD peer device.
* @cmd: Packet command code. * @cmd: Packet command code.
* @sector: sector, needs to be in big endian byte order * @sector: sector, needs to be in big endian byte order
* @blksize: size in byte, needs to be in big endian byte order * @blksize: size in byte, needs to be in big endian byte order
...@@ -1370,7 +1369,7 @@ void drbd_send_ack_rp(struct drbd_peer_device *peer_device, enum drbd_packet cmd ...@@ -1370,7 +1369,7 @@ void drbd_send_ack_rp(struct drbd_peer_device *peer_device, enum drbd_packet cmd
/** /**
* drbd_send_ack() - Sends an ack packet * drbd_send_ack() - Sends an ack packet
* @device: DRBD device * @peer_device: DRBD peer device
* @cmd: packet command code * @cmd: packet command code
* @peer_req: peer request * @peer_req: peer request
*/ */
...@@ -1882,7 +1881,7 @@ int drbd_send(struct drbd_connection *connection, struct socket *sock, ...@@ -1882,7 +1881,7 @@ int drbd_send(struct drbd_connection *connection, struct socket *sock,
return sent; return sent;
} }
/** /*
* drbd_send_all - Send an entire buffer * drbd_send_all - Send an entire buffer
* *
* Returns 0 upon success and a negative error value otherwise. * Returns 0 upon success and a negative error value otherwise.
...@@ -3509,6 +3508,7 @@ static int w_bitmap_io(struct drbd_work *w, int unused) ...@@ -3509,6 +3508,7 @@ static int w_bitmap_io(struct drbd_work *w, int unused)
* @io_fn: IO callback to be called when bitmap IO is possible * @io_fn: IO callback to be called when bitmap IO is possible
* @done: callback to be called after the bitmap IO was performed * @done: callback to be called after the bitmap IO was performed
* @why: Descriptive text of the reason for doing the IO * @why: Descriptive text of the reason for doing the IO
* @flags: Bitmap flags
* *
* While IO on the bitmap happens we freeze application IO thus we ensure * While IO on the bitmap happens we freeze application IO thus we ensure
* that drbd_set_out_of_sync() can not be called. This function MAY ONLY be * that drbd_set_out_of_sync() can not be called. This function MAY ONLY be
...@@ -3554,6 +3554,7 @@ void drbd_queue_bitmap_io(struct drbd_device *device, ...@@ -3554,6 +3554,7 @@ void drbd_queue_bitmap_io(struct drbd_device *device,
* @device: DRBD device. * @device: DRBD device.
* @io_fn: IO callback to be called when bitmap IO is possible * @io_fn: IO callback to be called when bitmap IO is possible
* @why: Descriptive text of the reason for doing the IO * @why: Descriptive text of the reason for doing the IO
* @flags: Bitmap flags
* *
* freezes application IO while that the actual IO operations runs. This * freezes application IO while that the actual IO operations runs. This
* functions MAY NOT be called from worker context. * functions MAY NOT be called from worker context.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment