On Mon, Jan 08, 2024 at 01:10:12PM -0800, Randy Dunlap wrote: > Hi Thomas, > > On 1/8/24 00:57, Thomas Zimmermann wrote: > > Hi, > > > > thanks for the fix. > > > > Am 06.01.24 um 04:29 schrieb Randy Dunlap: > >> Remove the @funcs entry from struct drm_vram_mm to quieten the kernel-doc > >> warning. > >> > >> Use the "define" kernel-doc keyword and an '\' line continuation > >> to fix another kernel-doc warning. > >> > >> drm_gem_vram_helper.h:129: warning: missing initial short description on line: > >> * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - > >> drm_gem_vram_helper.h:185: warning: Excess struct member 'funcs' description in 'drm_vram_mm' > >> > >> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> > >> Cc: David Airlie <airlied@xxxxxxxxx> > >> Cc: Daniel Vetter <daniel@xxxxxxxx> > >> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx > >> Cc: Maarten Lankhorst <maarten.lankhorst@xxxxxxxxxxxxxxx> > >> Cc: Maxime Ripard <mripard@xxxxxxxxxx> > >> Cc: Thomas Zimmermann <tzimmermann@xxxxxxx> > >> --- > >> v2: Add commit description > >> > >> base-commit: 610a9b8f49fbcf1100716370d3b5f6f884a2835a > >> > >> include/drm/drm_gem_vram_helper.h | 3 +-- > >> 1 file changed, 1 insertion(+), 2 deletions(-) > >> > >> diff -- a/include/drm/drm_gem_vram_helper.h b/include/drm/drm_gem_vram_helper.h > >> --- a/include/drm/drm_gem_vram_helper.h > >> +++ b/include/drm/drm_gem_vram_helper.h > >> @@ -126,7 +126,7 @@ drm_gem_vram_plane_helper_cleanup_fb(str > >> struct drm_plane_state *old_state); > >> /** > >> - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - > >> + * define DRM_GEM_VRAM_PLANE_HELPER_FUNCS - \ > > > > Did something change wrt. doc syntax? I think this used to work without warnings. About this 'define': we don't use is in another docs. Can we leave it out here or is this the new syntax? > > > > There are no doc syntax changes that I know of. This is not > new syntax. It has been around since 2014: > cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros") I had no idea this exists, thanks a lot for this TIL :-) I guess the issue here is that this exists, yay, but it's not documented with the other here: https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#structure-union-and-enumeration-documentation I guess a patch to kernel-doc.rst would be great. Adding some kernel-doc folks. Cheers, Sima -- Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch