From: Jani Nikula <jani.nikula@intel.com>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Subject: Re: [PATCH] drm: add documentation for tv connector state margins
Date: Tue, 20 Feb 2018 09:39:51 +0200 [thread overview]
Message-ID: <87r2pgcdo8.fsf@intel.com> (raw)
In-Reply-To: <20180219154536.GW22199@phenom.ffwll.local>
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
next prev parent reply other threads:[~2018-02-20 7:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2018-02-20 14:07 ` Jani Nikula
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r2pgcdo8.fsf@intel.com \
--to=jani.nikula@intel.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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.