回复：Re: [PATCH] drm: Fix kerneldoc for "Returns" section

[renjun wang]

Hi Andi


Thanks for your suggestion, I will carry it out next time.






Best Regards


                       
原始邮件
                       
                     

发件人："Andi Shyti"< andi.shyti at linux.intel.com >;

发件时间：2024/8/27 6:11

收件人："renjun wang"< renjunw0 at foxmail.com >;

抄送人："maarten.lankhorst"< maarten.lankhorst at linux.intel.com >;"mripard"< mripard at kernel.org >;"tzimmermann"< tzimmermann at suse.de >;"airlied"< airlied at gmail.com >;"daniel"< daniel at ffwll.ch >;"jani.nikula"< jani.nikula at linux.intel.com >;"joonas.lahtinen"< joonas.lahtinen at linux.intel.com >;"rodrigo.vivi"< rodrigo.vivi at intel.com >;"tursulin"< tursulin at ursulin.net >;"lyude"< lyude at redhat.com >;"imre.deak"< imre.deak at intel.com >;"Wayne.Lin"< Wayne.Lin at amd.com >;"ville.syrjala"< ville.syrjala at linux.intel.com >;"vidya.srinivas"< vidya.srinivas at intel.com >;"jouni.hogander"< jouni.hogander at intel.com >;"andi.shyti"< andi.shyti at linux.intel.com >;"janusz.krzysztofik"< janusz.krzysztofik at linux.intel.com >;"dri-devel"< dri-devel at lists.freedesktop.org >;"linux-kernel"< linux-kernel at vger.kernel.org >;"intel-gfx"< intel-gfx at lists.freedesktop.org >;

主题：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 
> ---
>  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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/intel-gfx/attachments/20240827/714f6a4c/attachment-0001.htm>