Unverified Commit feb85972 authored by Maxime Ripard's avatar Maxime Ripard
Browse files

cgroup/dmem: Fix parameters documentation 



During the dmem cgroup development, the parameters to the
dmem_cgroup_state_evict_valuable() and dmem_cgroup_try_charge() were
changed, but the documentation wasn't adjusted accordingly.

This results in a documentation build warning. Adjust the documentation
to reflect what the final functions parameters are.

Fixes: b168ed45 ("kernel/cgroup: Add "dmem" memory accounting cgroup")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/r/20250113160334.1f09f881@canb.auug.org.au/


Acked-by: default avatarTejun Heo <tj@kernel.org>
Reviewed-by: default avatarSimona Vetter <simona.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20250113092608.1349287-2-mripard@kernel.org


Signed-off-by: default avatarMaxime Ripard <mripard@kernel.org>
parent e33b5149

kernel/cgroup/dmem.c

+2 −5
Original line number Diff line number Diff line
@@ -280,8 +280,6 @@ dmem_cgroup_calculate_protection(struct dmem_cgroup_pool_state *limit_pool, 


/**

 * dmem_cgroup_state_evict_valuable() - Check if we should evict from test_pool

 * @dev: &dmem_cgroup_region

 * @index: The index number of the region being tested.

 * @limit_pool: The pool for which we hit limits

 * @test_pool: The pool for which to test

 * @ignore_low: Whether we have to respect low watermarks.
@@ -610,13 +608,12 @@ EXPORT_SYMBOL_GPL(dmem_cgroup_uncharge); 


/**

 * dmem_cgroup_try_charge() - Try charging a new allocation to a region.

 * @dev: Device to charge

 * @region: dmem region to charge

 * @size: Size (in bytes) to charge.

 * @ret_pool: On succesfull allocation, the pool that is charged.

 * @ret_limit_pool: On a failed allocation, the limiting pool.

 *

 * This function charges the current pool for @dev with region at @index for a

 * size of @size bytes.

 * This function charges the @region region for a size of @size bytes.

 *

 * If the function succeeds, @ret_pool is set, which must be passed to

 * dmem_cgroup_uncharge() when undoing the allocation.