tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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: Reinette Chatre <reinette.chatre@intel.com>
Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
Link: https://patch.msgid.link/1c50b9f7c73251c007133590986f127e1af57780.1775576382.git.reinette.chatre@intel.com

authored by

Reinette Chatre and committed by
Borislav Petkov (AMD) 79727019 c611752b

+8
+2
fs/resctrl/monitor.c
··· 234 234 * 235 235 * When the CLOSID and RMID are independent numbers, the first free CLOSID will 236 236 * be returned. 237 + * 238 + * Return: Free CLOSID on success, < 0 on failure. 237 239 */ 238 240 int resctrl_find_cleanest_closid(void) 239 241 {
+6
fs/resctrl/rdtgroup.c
··· 1519 1519 * 1520 1520 * @cbm is unsigned long, even if only 32 bits are used to make the 1521 1521 * bitmap functions work correctly. 1522 + * 1523 + * Return: Size (in bytes) of cache portion represented by CBM, 0 on failure. 1522 1524 */ 1523 1525 unsigned int rdtgroup_cbm_to_size(struct rdt_resource *r, 1524 1526 struct rdt_ctrl_domain *d, unsigned long cbm) ··· 3104 3102 * @mevt: The type of event file being created. 3105 3103 * @do_sum: Whether SNC summing monitors are being created. Only set 3106 3104 * when @rid == RDT_RESOURCE_L3. 3105 + * 3106 + * Return: Pointer to mon_data private data of the event, NULL on failure. 3107 3107 */ 3108 3108 static struct mon_data *mon_get_kn_priv(enum resctrl_res_level rid, int domid, 3109 3109 struct mon_evt *mevt, ··· 3500 3496 * resource group is initialized. The user can follow this with a 3501 3497 * modification to the CBM if the default does not satisfy the 3502 3498 * requirements. 3499 + * 3500 + * Return: A CBM that is valid for resource @r. 3503 3501 */ 3504 3502 static u32 cbm_ensure_valid(u32 _val, struct rdt_resource *r) 3505 3503 {