[PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Thomas Zimmermann]

Hi

Am 06.06.19 um 09:49 schrieb Daniel Vetter:
> On Thu, Jun 6, 2019 at 9:45 AM Gerd Hoffmann <kraxel at redhat.com> wrote:
>>
>> On Thu, Jun 06, 2019 at 08:39:12AM +0200, Thomas Zimmermann wrote:
>>> Hi
>>>
>>> Am 05.06.19 um 17:58 schrieb Gerd Hoffmann:
>>>> On Wed, Jun 05, 2019 at 11:59:04AM +0200, Thomas Zimmermann wrote:
>>>>> Hi
>>>>>
>>>>> Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:
>>>>>> On Tue, Jun 04, 2019 at 01:13:30PM +0200, Thomas Zimmermann wrote:
>>>>>>> The documentation tools interpret drm_gem_vram_mm_funcs as function and
>>>>>>> there appears to be no way of inline-documenting constants.
>>>>>>
>>>>>>> -/**
>>>>>>> +/*
>>>>>>>   * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm
>>>>>>
>>>>>> "struct drm_gem_vram_mm_funcs" ?
>>>>>>
>>>>>> (see include/drm/drm_gem.h where struct drm_gem_object_funcs is
>>>>>> documented that way).
>>>>>
>>>>> The documented source line is
>>>>>
>>>>>   const struct drm_vram_mm_funcs drm_gem_vram_mm_funcs = {
>>>>>
>>>>> and I tried to document the purpose of the constant 'drm_gem_vram_mm_funcs'.
>>>>
>>>> Ah.  Missed that detail.
>>>>
>>>>> Documenting global constants is not described in the kernel guide and I
>>>>> could not find a source-code example either. Function and struct style
>>>>> with '-' didn't work; member-field style with '@' neither. The only way
>>>>> seems to be adding it to an .rst file in Documentation. But then it's
>>>>> not part of the API documentation, but somewhere in the text.
>>>>
>>>> Ok, patch is fine then.
>>>>
>>>> Acked-by: Gerd Hoffmann <kraxel at redhat.com>
>>>
>>> Thanks.
>>>
>>>> (can you commit & push yourself meanwhile?)
>>>
>>> Not yet. The respective bug report is still open.
>>
>> Ok, I'll push it then.
> 
> You should have commit rights for drm-misc, I just checked. At least
> there's a tzimmermann account in the drm-misc group.

Thanks for the update.

Gerd, if you haven't pushed it yet I'm going to add this patch to the tree.

Best regards
Thomas

> https://drm.pages.freedesktop.org/maintainer-tools/getting-started.html
> 
> ... to get you going. If things don't work pls ping on #dri-devel on freenode.
> -Daniel
> 

-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Linux GmbH, Maxfeldstrasse 5, 90409 Nuernberg, Germany
GF: Felix Imendörffer, Mary Higgins, Sri Rasiah
HRB 21284 (AG Nürnberg)

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/dri-devel/attachments/20190606/da186c25/attachment.sig>