On Fri, 10 May 2024, Luca Coelho <luciano.coelho@xxxxxxxxx> wrote:
> The function descriptions are optional and have not yet been added to
> the DMC wakelock code, so we shouldn't try to use it. Since this is a
> regression, remove the kernel-doc entry for DMC wakelocks for now.
> The proper documentation will be added in a future patch.
I don't really think the kernel-doc documentation is necessary for
internal interfaces. I mean adding brief comments is fine, but no need
for this stuff to show up at docs.kernel.org.
Reviewed-by: Jani Nikula <jani.nikula@xxxxxxxxx>
>
> Fixes: 765425f598c2 ("drm/i915/display: add support for DMC wakelocks")
> Signed-off-by: Luca Coelho <luciano.coelho@xxxxxxxxx>
> ---
> Documentation/gpu/i915.rst | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 17261ba18313..3113e36f14cf 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -210,9 +210,6 @@ DMC wakelock support
> .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc_wl.c
> :doc: DMC wakelock support
>
> -.. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc_wl.c
> - :internal:
> -
> Video BIOS Table (VBT)
> ----------------------
--
Jani Nikula, Intel
