linux-kernel - Re: [PATCH] drm: Fix kerneldoc for "Returns" section

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Zsz9pwQ3m9zHrjo-@ashyti-mobl2.lan>
Date: Tue, 27 Aug 2024 00:11:51 +0200
From: Andi Shyti <andi.shyti@...ux.intel.com>
To: renjun wang <renjunw0@...mail.com>
Cc: maarten.lankhorst@...ux.intel.com, mripard@...nel.org,
	tzimmermann@...e.de, airlied@...il.com, daniel@...ll.ch,
	jani.nikula@...ux.intel.com, joonas.lahtinen@...ux.intel.com,
	rodrigo.vivi@...el.com, tursulin@...ulin.net, lyude@...hat.com,
	imre.deak@...el.com, Wayne.Lin@....com,
	ville.syrjala@...ux.intel.com, vidya.srinivas@...el.com,
	jouni.hogander@...el.com, andi.shyti@...ux.intel.com,
	janusz.krzysztofik@...ux.intel.com, dri-devel@...ts.freedesktop.org,
	linux-kernel@...r.kernel.org, intel-gfx@...ts.freedesktop.org
Subject: Re: [PATCH] drm: Fix kerneldoc for "Returns" section

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@...mail.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