diff mbox

drm/tve200: fix kernel-doc documentation comment include

Message ID 20180220142008.9330-1-jani.nikula@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Jani Nikula Feb. 20, 2018, 2:20 p.m. UTC
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

Cc: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Documentation/gpu/tve200.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Daniel Vetter Feb. 20, 2018, 4:34 p.m. UTC | #1
On Tue, Feb 20, 2018 at 04:20:08PM +0200, Jani Nikula wrote:
> 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
> 
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  Documentation/gpu/tve200.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/gpu/tve200.rst b/Documentation/gpu/tve200.rst
> index 69b17b324e12..152ea9398f7e 100644
> --- a/Documentation/gpu/tve200.rst
> +++ b/Documentation/gpu/tve200.rst
> @@ -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
> -- 
> 2.11.0
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Linus Walleij Feb. 21, 2018, 7:03 a.m. UTC | #2
On Tue, Feb 20, 2018 at 3:20 PM, Jani Nikula <jani.nikula@intel.com> wrote:

> 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
>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Whoa, good catch!

Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

Yours,
Linus Walleij
Jani Nikula Feb. 21, 2018, 7:36 a.m. UTC | #3
On Wed, 21 Feb 2018, Linus Walleij <linus.walleij@linaro.org> wrote:
> On Tue, Feb 20, 2018 at 3:20 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>
>> 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
>>
>> Cc: Linus Walleij <linus.walleij@linaro.org>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>
> Whoa, good catch!
>
> Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

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

BR,
Jani.
diff mbox

Patch

diff --git a/Documentation/gpu/tve200.rst b/Documentation/gpu/tve200.rst
index 69b17b324e12..152ea9398f7e 100644
--- a/Documentation/gpu/tve200.rst
+++ b/Documentation/gpu/tve200.rst
@@ -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