Skip to contentSkip to conversation

drm/tve200: fix kernel-doc documentation comment include

PATCH In review Jani Nikula 3 participants 4 messages Feb 20, 2018 – Feb 21, 2018

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/tve200: fix kernel-doc documentation comment include

The DOC: line acts as an identifier for the :doc: include. Fixes:

./drivers/gpu/drm/tve200/tve200_drv.c:1: warning: no structured comments found

---
 Documentation/gpu/tve200.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gpu/tve200.rst +1 -1
index 69b17b324e12..152ea9398f7e 100644
@@ -3,4 +3,4 @@
 ==================================
 
 .. kernel-doc:: drivers/gpu/drm/tve200/tve200_drv.c
-   :doc: Faraday TV Encoder 200
+   :doc: Faraday TV Encoder TVE200 DRM Driver
Signature · 6 lines
2.11.0

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · Jani Nikula

The DOC: line acts as an identifier for the :doc: include. Fixes:

./drivers/gpu/drm/tve200/tve200_drv.c:1: warning: no structured comments found

Quoted 21 lines
---
 Documentation/gpu/tve200.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gpu/tve200.rst +1 -1
index 69b17b324e12..152ea9398f7e 100644
@@ -3,4 +3,4 @@
 ==================================
 
 .. kernel-doc:: drivers/gpu/drm/tve200/tve200_drv.c
-   :doc: Faraday TV Encoder 200
+   :doc: Faraday TV Encoder TVE200 DRM Driver
Signature · 6 lines
2.11.0

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Reviewed-by on v1 1/1
#2 lore raw
In reply to Jani Nikula
Quoted 6 lines · Jani Nikula

The DOC: line acts as an identifier for the :doc: include. Fixes:

./drivers/gpu/drm/tve200/tve200_drv.c:1: warning: no structured comments found

Whoa, good catch!

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

author Applied
#3 lore raw
Quoted 4 lines · Linus Walleij
Quoted 2 lines · Jani Nikula

The DOC: line acts as an identifier for the :doc: include. Fixes:

Quoted 8 lines
Quoted 4 lines

./drivers/gpu/drm/tve200/tve200_drv.c:1: warning: no structured comments found

Whoa, good catch!

Pushed to drm-misc-fixes, thanks for the review.

BR,
Jani.

Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel