LU-17869 llapi: Fixed function header comments

Updated input parameter descriptions for
`llapi_layout_v2_sanity` and `llapi_layout_sanity` functions.

Test-parameters: trivial
Fixes: ee7dfc5ad1 ("LU-17025 llapi: Verify stripe pool name")
Signed-off-by: Rajeev Mishra <rajeevm@hpe.com>
Change-Id: I72f4973d8be70ad60d088ea0e18d1e961f01cd50
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/55180
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
Reviewed-by: Petros Koutoupis <petros.koutoupis@hpe.com>
Reviewed-by: Shaun Tancheff <shaun.tancheff@hpe.com>

diff --git a/lustre/utils/liblustreapi_layout.c b/lustre/utils/liblustreapi_layout.c
index 6447d6f..066d6e9 100644 (file)
--- a/lustre/utils/liblustreapi_layout.c
+++ b/lustre/utils/liblustreapi_layout.c
@@ -3856,7 +3856,6 @@ void llapi_layout_sanity_perror(int error)
  * components"?
  *
  * \param[in] layout            component layout list.
- * \param[in] fname            file the layout to be checked for
  * \param[in] incomplete        if layout is complete or not - some checks can
  *                              only be done on complete layouts.
  * \param[in] flr              set when this is called from FLR mirror create
@@ -3877,7 +3876,6 @@ int llapi_layout_sanity(struct llapi_layout *layout,
  * of the sanity function is passing NULL for the filename
  * Input arguments ---
  * \param[in] layout            component layout list.
- * \param[in] fname            file the layout to be checked for
  * \param[in] incomplete        if layout is complete or not - some checks can
  *                              only be done on complete layouts.
  * \param[in] flr              set when this is called from FLR mirror create
@@ -3885,6 +3883,7 @@ int llapi_layout_sanity(struct llapi_layout *layout,
  *                             NULL no pool name check is performed
  *
  * \retval                      0, success, positive: various errors, see
+ *                              llapi_layout_sanity_perror, -1, failure
  */
 
 int llapi_layout_v2_sanity(struct llapi_layout *layout,