[PATCH] drm: Fix kerneldoc for "Returns" section

Andi Shyti andi.shyti at linux.intel.com
Mon Aug 26 22:11:51 UTC 2024


Hi Renjun,

On Sat, Aug 24, 2024 at 04:36:34PM +0800, renjun wang wrote:
> The blank line between title "Returns:" and detail description is not
> allowed, otherwise the title will goes under the description block in
> generated .html file after running `make htmldocs`.
> 
> There are a few examples for current kerneldoc:
> https://www.kernel.org/doc/html/latest/gpu/drm-kms.html#c.drm_crtc_commit_wait
> https://www.kernel.org/doc/html/latest/gpu/drm-kms.html#c.drm_atomic_get_crtc_state
> https://www.kernel.org/doc/html/latest/gpu/i915.html#c.i915_vma_pin_fence
> 
> Signed-off-by: renjun wang <renjunw0 at foxmail.com>
> ---
>  drivers/gpu/drm/display/drm_dp_mst_topology.c | 4 ----
>  drivers/gpu/drm/drm_atomic.c                  | 6 ------
>  drivers/gpu/drm/drm_atomic_helper.c           | 2 --
>  drivers/gpu/drm/drm_file.c                    | 7 -------
>  drivers/gpu/drm/drm_gem.c                     | 7 ++-----
>  drivers/gpu/drm/drm_modes.c                   | 1 -
>  drivers/gpu/drm/drm_rect.c                    | 1 -
>  drivers/gpu/drm/drm_vblank.c                  | 2 --
>  drivers/gpu/drm/i915/gem/i915_gem_object.h    | 1 -
>  drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c  | 1 -
>  drivers/gpu/drm/i915/i915_vma.h               | 1 -
>  11 files changed, 2 insertions(+), 31 deletions(-)

next time, please, split the series so that each component goes
to the right branch.

Andi


More information about the dri-devel mailing list