Skip to contentSkip to conversation

drm: Ignore drm_gem_vram_mm_funcs in generated documentation

PATCH In review Thomas Zimmermann 3 participants 8 messages Jun 4, 2019 – Jun 6, 2019

Subsystems (2)
lore
Share & tools
lore

Thomas Zimmermann

author maintainer
#0 lore raw

PATCH 1/1 drm: Ignore drm_gem_vram_mm_funcs in generated documentation

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.

Fixes 5c9dcacfe56673555540933017c54e8f39e947cb
---
 drivers/gpu/drm/drm_gem_vram_helper.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
index 7380a06a582c..42ad80888df7 100644
@@ -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
Signature · 6 lines
2.21.0

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
#1 lore raw

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines · Thomas Zimmermann

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * 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
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

author maintainer
#2 lore raw

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 12 lines · Thomas Zimmermann

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * 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

Quoted 3 lines

cheers,
Gerd

Signature · 5 lines
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)

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Acked-by
#3 lore raw
Quoted 13 lines · Thomas Zimmermann

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 10 lines · Thomas Zimmermann

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm

"struct drm_gem_vram_mm_funcs" ?

Quoted 8 lines
Quoted 2 lines

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

Quoted 5 lines

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.

(can you commit & push yourself meanwhile?)

cheers,
Gerd

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

author maintainer
#4 lore raw

Hi

Am 05.06.19 um 17:58 schrieb Gerd Hoffmann:

Quoted 31 lines · Thomas Zimmermann
Quoted 13 lines

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 10 lines · Thomas Zimmermann

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm

"struct drm_gem_vram_mm_funcs" ?

Quoted 8 lines
Quoted 2 lines

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

Quoted 5 lines

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.

Quoted 3 lines

Ok, patch is fine then.

Thanks.

Quoted 1 line

(can you commit & push yourself meanwhile?)

Not yet. The respective bug report is still open.

Best regards
Thomas

Quoted 8 lines

cheers,
Gerd

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Signature · 5 lines
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)

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#5 lore raw
Quoted 36 lines · Thomas Zimmermann

Hi

Am 05.06.19 um 17:58 schrieb Gerd Hoffmann:

Quoted 33 lines · Thomas Zimmermann
Quoted 13 lines

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 10 lines · Thomas Zimmermann

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm

"struct drm_gem_vram_mm_funcs" ?

Quoted 8 lines
Quoted 2 lines

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

Quoted 5 lines

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.

Quoted 7 lines
Quoted 1 line

Thanks.

Quoted 1 line

(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
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#6 lore raw
Quoted 40 lines · Gerd Hoffmann
Quoted 38 lines · Thomas Zimmermann

Hi

Am 05.06.19 um 17:58 schrieb Gerd Hoffmann:

Quoted 34 lines · Thomas Zimmermann
Quoted 13 lines

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 10 lines · Thomas Zimmermann

drivers/gpu/drm/drm_gem_vram_helper.c int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, · line 589

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

drivers/gpu/drm/drm_gem_vram_helper.c +1 -1
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm

"struct drm_gem_vram_mm_funcs" ?

Quoted 8 lines
Quoted 2 lines

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

Quoted 5 lines

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.

Quoted 7 lines
Quoted 5 lines

Thanks.

Quoted 1 line

(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

Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
author maintainer
#7 lore raw

Hi

Am 06.06.19 um 09:49 schrieb Daniel Vetter:

Quoted 43 lines · Gerd Hoffmann
Quoted 42 lines · Thomas Zimmermann
Quoted 40 lines

Hi

Am 05.06.19 um 17:58 schrieb Gerd Hoffmann:

Quoted 31 lines · Thomas Zimmermann
Quoted 13 lines

Hi

Am 05.06.19 um 11:03 schrieb Gerd Hoffmann:

Quoted 10 lines · Thomas Zimmermann

Review

Quoted 6 lines

The documentation tools interpret drm_gem_vram_mm_funcs as function and there appears to be no way of inline-documenting constants.

(quoted diff) +1 -1
-/**
+/*
  * drm_gem_vram_mm_funcs - Functions for &struct drm_vram_mm

"struct drm_gem_vram_mm_funcs" ?

Quoted 8 lines
Quoted 2 lines

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

Quoted 5 lines

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.

Quoted 3 lines

Ok, patch is fine then.

Thanks.

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines
Quoted 1 line

(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

Quoted 5 lines

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

Signature · 5 lines
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)

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel