Commit 79727019 authored by Reinette Chatre's avatar Reinette Chatre Committed by Borislav Petkov (AMD)
Browse files

fs/resctrl: Add missing return value descriptions 



Using the stricter "./tools/docs/kernel-doc -Wall -v" to verify proper
formatting of documentation comments includes warnings related to return
markup on functions that are omitted during the default verification
checks. This stricter verification reports a couple of missing return
descriptions in resctrl:

    Warning: .../fs/resctrl/rdtgroup.c:1536 No description found for return value of 'rdtgroup_cbm_to_size'
    Warning: .../fs/resctrl/rdtgroup.c:3131 No description found for return value of 'mon_get_kn_priv'
    Warning: .../fs/resctrl/rdtgroup.c:3523 No description found for return value of 'cbm_ensure_valid'
    Warning: .../fs/resctrl/monitor.c:238 No description found for return value of 'resctrl_find_cleanest_closid'

Add the missing return descriptions.

Signed-off-by: default avatarReinette Chatre <reinette.chatre@intel.com>
Signed-off-by: default avatarBorislav Petkov (AMD) <bp@alien8.de>
Link: https://patch.msgid.link/1c50b9f7c73251c007133590986f127e1af57780.1775576382.git.reinette.chatre@intel.com
parent c611752b

fs/resctrl/monitor.c

+2 −0
Original line number Diff line number Diff line
@@ -234,6 +234,8 @@ static struct rmid_entry *resctrl_find_free_rmid(u32 closid) 
 *

 * When the CLOSID and RMID are independent numbers, the first free CLOSID will

 * be returned.

 *

 * Return: Free CLOSID on success, < 0 on failure.

 */

int resctrl_find_cleanest_closid(void)

{

fs/resctrl/rdtgroup.c

+6 −0
Original line number Diff line number Diff line
@@ -1519,6 +1519,8 @@ static ssize_t rdtgroup_mode_write(struct kernfs_open_file *of, 
 *

 * @cbm is unsigned long, even if only 32 bits are used to make the

 * bitmap functions work correctly.

 *

 * Return: Size (in bytes) of cache portion represented by CBM, 0 on failure.

 */

unsigned int rdtgroup_cbm_to_size(struct rdt_resource *r,

				  struct rdt_ctrl_domain *d, unsigned long cbm)
@@ -3102,6 +3104,8 @@ static void rmdir_all_sub(void) 
 * @mevt:   The type of event file being created.

 * @do_sum: Whether SNC summing monitors are being created. Only set

 *	    when @rid == RDT_RESOURCE_L3.

 *

 * Return: Pointer to mon_data private data of the event, NULL on failure.

 */

static struct mon_data *mon_get_kn_priv(enum resctrl_res_level rid, int domid,

					struct mon_evt *mevt,
@@ -3496,6 +3500,8 @@ static int mkdir_mondata_all(struct kernfs_node *parent_kn, 
 * resource group is initialized. The user can follow this with a

 * modification to the CBM if the default does not satisfy the

 * requirements.

 *

 * Return: A CBM that is valid for resource @r.

 */

static u32 cbm_ensure_valid(u32 _val, struct rdt_resource *r)

{