Re: [PATCH v1 1/2] drm/ttm: drop stale @ctx kernel-doc entry

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The commit message incorrectly claims it is fixing the documentation for `struct ttm_bo_alloc_state` rather than the function `ttm_bo_alloc_at_place()`.
--

--- Patch [1]: [PATCH v1 1/2] drm/ttm: drop stale @ctx kernel-doc entry ---
commit eda6deffe5de61d4cef4644920a61899181f3f40
Author: Sean Chang <[email protected]>

drm/ttm: drop stale @ctx kernel-doc entry

This commit removes a stale @ctx kernel-doc entry in ttm_bo.c to fix a
documentation mismatch.

> ttm_bo_alloc_state no longer has a ctx member, but its kernel-doc
> comment still documents @ctx. Remove the stale entry so the
> documentation matches the struct.

[Severity: Low]
This isn't a bug, but is this description accurate?

The commit message states the documentation for struct ttm_bo_alloc_state
is being fixed, but the modified kernel-doc block actually documents the
function ttm_bo_alloc_at_place(). 

It appears the diff chunk header below mistakenly picked up the struct 
definition from earlier in the file, which may have caused the confusion.

> diff --git a/drivers/gpu/drm/ttm/ttm_bo.c b/drivers/gpu/drm/ttm/ttm_bo.c
> index ef56c18ded1b8..943297b49dc53 100644
> --- a/drivers/gpu/drm/ttm/ttm_bo.c
> +++ b/drivers/gpu/drm/ttm/ttm_bo.c
> @@ -506,7 +506,6 @@ struct ttm_bo_alloc_state {
>   *
>   * @bo: The buffer to allocate the backing store of
>   * @place: The place to attempt allocation in
> - * @ctx: ttm_operation_ctx associated with this allocation
>   * @force_space: If we should evict buffers to force space
>   * @res: On allocation success, the resulting struct ttm_resource.
>   * @alloc_state: Object holding allocation state such as charged cgroups.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1