From: Lyude Paul <lyude@redhat.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: "Jonathan Corbet" <corbet@lwn.net>,
"Ville Syrjälä" <ville.syrjala@linux.intel.com>,
"Daniel Vetter" <daniel@ffwll.ch>,
"David Airlie" <airlied@linux.ie>,
"Maarten Lankhorst" <maarten.lankhorst@linux.intel.com>,
"Maxime Ripard" <mripard@kernel.org>,
"Thomas Zimmermann" <tzimmermann@suse.de>,
dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 11/24] drm/dp: fix kernel-doc warnings at drm_dp_helper.c
Date: Tue, 13 Oct 2020 15:20:17 -0400 [thread overview]
Message-ID: <7ac5989093cc0dfed7429dc99a0983d8a3a25068.camel@redhat.com> (raw)
In-Reply-To: <c7b13b7f9dae481fe552e3b8382841469bb993f0.1602590106.git.mchehab+huawei@kernel.org>
Reviewed-by: Lyude Paul <lyude@redhat.com>
On Tue, 2020-10-13 at 14:14 +0200, Mauro Carvalho Chehab wrote:
> As warned by kernel-doc:
>
> ./drivers/gpu/drm/drm_dp_helper.c:385: warning: Function parameter or
> member 'type' not described in 'drm_dp_downstream_is_type'
> ./drivers/gpu/drm/drm_dp_helper.c:886: warning: Function parameter or
> member 'dev' not described in 'drm_dp_downstream_mode'
>
> Some function parameters weren't documented.
>
> Fixes: 38784f6f8805 ("drm/dp: Add helpers to identify downstream facing port
> types")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> drivers/gpu/drm/drm_dp_helper.c | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/drivers/gpu/drm/drm_dp_helper.c b/drivers/gpu/drm/drm_dp_helper.c
> index b1c71af88579..deeed73f4ed6 100644
> --- a/drivers/gpu/drm/drm_dp_helper.c
> +++ b/drivers/gpu/drm/drm_dp_helper.c
> @@ -374,6 +374,10 @@ static bool is_edid_digital_input_dp(const struct edid
> *edid)
> * drm_dp_downstream_is_type() - is the downstream facing port of certain
> type?
> * @dpcd: DisplayPort configuration data
> * @port_cap: port capabilities
> + * @type: port type to be checked. Can be:
> + * %DP_DS_PORT_TYPE_DP, %DP_DS_PORT_TYPE_VGA, %DP_DS_PORT_TYPE_DVI,
> + * %DP_DS_PORT_TYPE_HDMI, %DP_DS_PORT_TYPE_NON_EDID,
> + * %DP_DS_PORT_TYPE_DP_DUALMODE or %DP_DS_PORT_TYPE_WIRELESS.
> *
> * Caveat: Only works with DPCD 1.1+ port caps.
> *
> @@ -870,6 +874,7 @@ EXPORT_SYMBOL(drm_dp_downstream_444_to_420_conversion);
>
> /**
> * drm_dp_downstream_mode() - return a mode for downstream facing port
> + * @dev: DRM device
> * @dpcd: DisplayPort configuration data
> * @port_cap: port capabilities
> *
--
Sincerely,
Lyude Paul (she/her)
Software Engineer at Red Hat
Note: I deal with a lot of emails and have a lot of bugs on my plate. If you've
asked me a question, are waiting for a review/merge on a patch, etc. and I
haven't responded in a while, please feel free to send me another email to check
on my status. I don't bite!
next prev parent reply other threads:[~2020-10-13 19:20 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-13 12:14 [PATCH v2 00/24] Documentation build fixes against next-20201013 Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 01/24] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 02/24] tools: docs: memory-model: fix references for some files Mauro Carvalho Chehab
2020-10-13 16:33 ` Paul E. McKenney
2020-10-13 16:38 ` Alan Stern
2020-10-14 1:58 ` Paul E. McKenney
2020-10-14 7:56 ` Mauro Carvalho Chehab
2020-10-14 14:14 ` Akira Yokosawa
2020-10-14 14:39 ` Mauro Carvalho Chehab
2020-10-14 18:57 ` Paul E. McKenney
2020-10-15 5:15 ` Mauro Carvalho Chehab
2020-10-15 10:30 ` Peter Zijlstra
2020-10-13 12:14 ` [PATCH v2 03/24] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 04/24] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-13 12:52 ` Peter Zijlstra
2020-10-13 13:11 ` Matthew Wilcox
2020-10-13 14:09 ` Peter Zijlstra
2020-10-13 15:02 ` Matthew Wilcox
2020-10-14 16:04 ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 05/24] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 06/24] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-13 13:29 ` John Garry
2020-10-13 19:12 ` Jens Axboe
2020-10-13 12:14 ` [PATCH v2 07/24] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-13 12:41 ` Christian König
2020-10-13 12:14 ` [PATCH v2 08/24] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 09/24] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-13 12:26 ` Matthew Wilcox
2020-10-21 9:55 ` Mauro Carvalho Chehab
2020-10-21 11:28 ` Matthew Wilcox
2020-10-21 11:59 ` Mauro Carvalho Chehab
2020-10-21 12:02 ` Matthew Wilcox
2020-10-13 12:14 ` [PATCH v2 11/24] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-13 19:20 ` Lyude Paul [this message]
2020-10-13 12:14 ` [PATCH v2 12/24] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-13 19:24 ` Lyude Paul
2020-10-13 19:49 ` Lyude Paul
2020-10-21 10:11 ` Mauro Carvalho Chehab
2020-10-21 16:56 ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 13/24] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-13 15:53 ` Wolfram Sang
2020-10-13 12:14 ` [PATCH v2 14/24] docs: conf.py: disable automarkup for Sphinx 3.x Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 15/24] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 16/24] seqlock: fix two kernel-doc warnings Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 17/24] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 18/24] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 19/24] net: phy: remove kernel-doc duplication Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 20/24] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 21/24] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 22/24] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-13 22:01 ` Jacob Keller
2020-10-13 12:14 ` [PATCH v2 23/24] RDMA: add a missing kernel-doc parameter markup Mauro Carvalho Chehab
2020-10-16 16:57 ` Jason Gunthorpe
2020-10-13 12:14 ` [PATCH v2 24/24] counters: docs: add a missing include Mauro Carvalho Chehab
2020-10-15 1:06 ` Shuah Khan
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=7ac5989093cc0dfed7429dc99a0983d8a3a25068.camel@redhat.com \
--to=lyude@redhat.com \
--cc=airlied@linux.ie \
--cc=corbet@lwn.net \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mchehab+huawei@kernel.org \
--cc=mripard@kernel.org \
--cc=tzimmermann@suse.de \
--cc=ville.syrjala@linux.intel.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).