* [PATCH] drm: add documentation for tv connector state margins
@ 2018-02-19 10:40 Jani Nikula
2018-02-19 15:45 ` Daniel Vetter
0 siblings, 1 reply; 4+ messages in thread
From: Jani Nikula @ 2018-02-19 10:40 UTC (permalink / raw)
To: dri-devel; +Cc: Jani Nikula
A bit boring documentation fix, but gets rid of the warnings:
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'
./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
include/drm/drm_connector.h | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index 758a176e7b57..675cc3f8cf85 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,
/**
* struct drm_tv_connector_state - TV connector related states
* @subconnector: selected subconnector
- * @margins: left/right/top/bottom margins
+ * @margins: margins
+ * @margins.left: left margin
+ * @margins.right: right margin
+ * @margins.top: top margin
+ * @margins.bottom: bottom margin
* @mode: TV mode
* @brightness: brightness in percent
* @contrast: contrast in percent
--
2.11.0
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: add documentation for tv connector state margins
2018-02-19 10:40 [PATCH] drm: add documentation for tv connector state margins Jani Nikula
@ 2018-02-19 15:45 ` Daniel Vetter
2018-02-20 7:39 ` Jani Nikula
2018-02-20 14:07 ` Jani Nikula
0 siblings, 2 replies; 4+ messages in thread
From: Daniel Vetter @ 2018-02-19 15:45 UTC (permalink / raw)
To: Jani Nikula; +Cc: dri-devel
On Mon, Feb 19, 2018 at 12:40:09PM +0200, Jani Nikula wrote:
> A bit boring documentation fix, but gets rid of the warnings:
>
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'
> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
> include/drm/drm_connector.h | 6 +++++-
> 1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index 758a176e7b57..675cc3f8cf85 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,
> /**
> * struct drm_tv_connector_state - TV connector related states
> * @subconnector: selected subconnector
> - * @margins: left/right/top/bottom margins
> + * @margins: margins
> + * @margins.left: left margin
> + * @margins.right: right margin
> + * @margins.top: top margin
> + * @margins.bottom: bottom margin
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Well, applying this will now generate a warning on older kerneldocs (due
to lack of docs for @margins), but oh well. Can/should we keep both?
-Daniel
> * @mode: TV mode
> * @brightness: brightness in percent
> * @contrast: contrast in percent
> --
> 2.11.0
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: add documentation for tv connector state margins
2018-02-19 15:45 ` Daniel Vetter
@ 2018-02-20 7:39 ` Jani Nikula
2018-02-20 14:07 ` Jani Nikula
1 sibling, 0 replies; 4+ messages in thread
From: Jani Nikula @ 2018-02-20 7:39 UTC (permalink / raw)
To: Daniel Vetter; +Cc: dri-devel
On Mon, 19 Feb 2018, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Mon, Feb 19, 2018 at 12:40:09PM +0200, Jani Nikula wrote:
>> A bit boring documentation fix, but gets rid of the warnings:
>>
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>> include/drm/drm_connector.h | 6 +++++-
>> 1 file changed, 5 insertions(+), 1 deletion(-)
>>
>> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
>> index 758a176e7b57..675cc3f8cf85 100644
>> --- a/include/drm/drm_connector.h
>> +++ b/include/drm/drm_connector.h
>> @@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,
>> /**
>> * struct drm_tv_connector_state - TV connector related states
>> * @subconnector: selected subconnector
>> - * @margins: left/right/top/bottom margins
>> + * @margins: margins
>> + * @margins.left: left margin
>> + * @margins.right: right margin
>> + * @margins.top: top margin
>> + * @margins.bottom: bottom margin
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
>
> Well, applying this will now generate a warning on older kerneldocs (due
> to lack of docs for @margins), but oh well. Can/should we keep both?
@margins is still there. But old kernel-doc might warn about excess
documentation it doesn't know how to parse.
BR,
Jani.
> -Daniel
>
>> * @mode: TV mode
>> * @brightness: brightness in percent
>> * @contrast: contrast in percent
>> --
>> 2.11.0
>>
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] drm: add documentation for tv connector state margins
2018-02-19 15:45 ` Daniel Vetter
2018-02-20 7:39 ` Jani Nikula
@ 2018-02-20 14:07 ` Jani Nikula
1 sibling, 0 replies; 4+ messages in thread
From: Jani Nikula @ 2018-02-20 14:07 UTC (permalink / raw)
To: Daniel Vetter; +Cc: dri-devel
On Mon, 19 Feb 2018, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Mon, Feb 19, 2018 at 12:40:09PM +0200, Jani Nikula wrote:
>> A bit boring documentation fix, but gets rid of the warnings:
>>
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.left' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.right' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.top' not described in 'drm_tv_connector_state'
>> ./include/drm/drm_connector.h:370: warning: Function parameter or member 'margins.bottom' not described in 'drm_tv_connector_state'
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>> include/drm/drm_connector.h | 6 +++++-
>> 1 file changed, 5 insertions(+), 1 deletion(-)
>>
>> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
>> index 758a176e7b57..675cc3f8cf85 100644
>> --- a/include/drm/drm_connector.h
>> +++ b/include/drm/drm_connector.h
>> @@ -342,7 +342,11 @@ int drm_display_info_set_bus_formats(struct drm_display_info *info,
>> /**
>> * struct drm_tv_connector_state - TV connector related states
>> * @subconnector: selected subconnector
>> - * @margins: left/right/top/bottom margins
>> + * @margins: margins
>> + * @margins.left: left margin
>> + * @margins.right: right margin
>> + * @margins.top: top margin
>> + * @margins.bottom: bottom margin
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Pushed to drm-misc-next, thanks for the review.
BR,
Jani.
>
> Well, applying this will now generate a warning on older kerneldocs (due
> to lack of docs for @margins), but oh well. Can/should we keep both?
> -Daniel
>
>> * @mode: TV mode
>> * @brightness: brightness in percent
>> * @contrast: contrast in percent
>> --
>> 2.11.0
>>
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2018-02-20 14:07 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-02-19 10:40 [PATCH] drm: add documentation for tv connector state margins Jani Nikula
2018-02-19 15:45 ` Daniel Vetter
2018-02-20 7:39 ` Jani Nikula
2018-02-20 14:07 ` Jani Nikula
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.