From 9d3b1febc8534bb87686c81bdfa640ed641de219 Mon Sep 17 00:00:00 2001 From: Arshad Hussain Date: Fri, 14 Mar 2025 13:32:12 +0530 Subject: [PATCH] LU-9633 mgc: Add kernel doc style for mgc/mgc_request.c This patch converts existing functional comments to kernel doc style comments and removes '/**' for comments which is not meant to be a kernel-doc comment Test-Parameters: trivial Signed-off-by: Arshad Hussain Change-Id: I0b498281acd9f5d5f48f02d436e2add8df4021ae Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58417 Tested-by: jenkins Tested-by: Maloo Reviewed-by: Andreas Dilger Reviewed-by: Petros Koutoupis Reviewed-by: Anjus George Reviewed-by: Oleg Drokin --- lustre/mgc/mgc_request.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lustre/mgc/mgc_request.c b/lustre/mgc/mgc_request.c index cdf25c0..672f78d 100644 --- a/lustre/mgc/mgc_request.c +++ b/lustre/mgc/mgc_request.c @@ -1464,7 +1464,7 @@ free_nids: RETURN(rc); } -/** +/* * This function is called if this client was notified for target restarting * by the MGS. A CONFIG_READ RPC is going to send to fetch recovery or * nodemap logs. @@ -1709,7 +1709,9 @@ static bool mgc_import_in_recovery(struct obd_import *imp) } /** - * Get a configuration log from the MGS and process it. + * mgc_process_log() - Get a configuration log from the MGS and process it + * @mgc: MGC device by which to fetch the configuration log + * @cld: log processing state (stored in lock callback data) * * This function is called for both clients and servers to process the * configuration log from the MGS. The MGC enqueues a DLM lock on the @@ -1719,7 +1721,7 @@ static bool mgc_import_in_recovery(struct obd_import *imp) * the new additions to the end of the log. * * Since the MGC import is not replayable, if the import is being evicted - * (rcl == -ESHUTDOWN, \see ptlrpc_import_delay_req()), retry to process + * (rcl == -ESHUTDOWN, @ptlrpc_import_delay_req()), retry to process * the log until recovery is finished or the import is closed. * * Make a local copy of the log before parsing it if appropriate (non-MGS @@ -1730,11 +1732,9 @@ static bool mgc_import_in_recovery(struct obd_import *imp) * trying to update from the same log simultaneously, in which case we * should use a per-log semaphore instead of cld_lock. * - * \param[in] mgc MGC device by which to fetch the configuration log - * \param[in] cld log processing state (stored in lock callback data) - * - * \retval 0 on success - * \retval negative errno on failure + * Return: + * * %0: Success + * * %negative: Failure */ int mgc_process_log(struct obd_device *mgc, struct config_llog_data *cld) { -- 1.8.3.1