[PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Thomas Zimmermann]

The documentation tools interpret drm_gem_vram_mm_funcs as function and
there appears to be no way of inline-documenting constants. This results
in a warning by 'make htmldocs'. For now, removing drm_gem_vram_mm_funcs
from generated documentation works around the issue.

Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
Fixes: 5c9dcacfe56673555540933017c54e8f39e947cb
---
 drivers/gpu/drm/drm_gem_vram_helper.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/drm_gem_vram_helper.c b/drivers/gpu/drm/drm_gem_vram_helper.c
index 7380a06a582c..42ad80888df7 100644
--- a/drivers/gpu/drm/drm_gem_vram_helper.c
+++ b/drivers/gpu/drm/drm_gem_vram_helper.c
@@ -585,7 +585,7 @@ int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo,
 }
 EXPORT_SYMBOL(drm_gem_vram_bo_driver_verify_access);
 
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm
  *
  * Most users of @struct drm_gem_vram_object will also use
-- 
2.21.0

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[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).

cheers,
  Gerd

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Thomas Zimmermann]

[-- Attachment #1.1.1: Type: text/plain, Size: 1258 bytes --]

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'.

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.

Best regards
Thomas


> cheers,
>   Gerd
> 

-- 
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)


[-- Attachment #1.2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[-- Attachment #2: Type: text/plain, Size: 159 bytes --]

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[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@redhat.com>

(can you commit & push yourself meanwhile?)

cheers,
  Gerd

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Thomas Zimmermann]

[-- Attachment #1.1.1: Type: text/plain, Size: 1841 bytes --]

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@redhat.com>

Thanks.

> (can you commit & push yourself meanwhile?)

Not yet. The respective bug report is still open.

Best regards
Thomas

> cheers,
>   Gerd
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
> 

-- 
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)


[-- Attachment #1.2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[-- Attachment #2: Type: text/plain, Size: 159 bytes --]

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Gerd Hoffmann]

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@redhat.com>
> 
> Thanks.
> 
> > (can you commit & push yourself meanwhile?)
> 
> Not yet. The respective bug report is still open.

Ok, I'll push it then.

cheers,
  Gerd

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Daniel Vetter]

On Thu, Jun 6, 2019 at 9:45 AM Gerd Hoffmann <kraxel@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@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.

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
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm: Ignore drm_gem_vram_mm_funcs in generated documentation

[Thomas Zimmermann]

[-- Attachment #1.1.1: Type: text/plain, Size: 2414 bytes --]

Hi

Am 06.06.19 um 09:49 schrieb Daniel Vetter:
> On Thu, Jun 6, 2019 at 9:45 AM Gerd Hoffmann <kraxel@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@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)


[-- Attachment #1.2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[-- Attachment #2: Type: text/plain, Size: 159 bytes --]

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel