drm/dp: Add missing description to parameter
diff mbox

Message ID 20170307203511.14258-1-tomeu.vizoso@collabora.com
State New
Headers show

Commit Message

Tomeu Vizoso March 7, 2017, 8:35 p.m. UTC
Gabriel Krisman reported these warnings when building the documentation:

 ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
for parameter 'crtc'
./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
for parameter 'crtc'

Signed-off-by: Tomeu Vizoso <tomeu.vizoso@collabora.com>
---
 drivers/gpu/drm/drm_dp_helper.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Sean Paul March 7, 2017, 10:03 p.m. UTC | #1
On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
> Gabriel Krisman reported these warnings when building the documentation:
> 
>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
> for parameter 'crtc'
> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
> for parameter 'crtc'
> 

I've now added htmldocs build to my pre-merge build testing so I'll hopefully
catch this earlier (no promises).

In the meantime, this has been applied to -misc

Thanks,

Sean

> Signed-off-by: Tomeu Vizoso <tomeu.vizoso@collabora.com>
> ---
>  drivers/gpu/drm/drm_dp_helper.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/gpu/drm/drm_dp_helper.c b/drivers/gpu/drm/drm_dp_helper.c
> index c40cfe2e63ab..3e5f52110ea1 100644
> --- a/drivers/gpu/drm/drm_dp_helper.c
> +++ b/drivers/gpu/drm/drm_dp_helper.c
> @@ -1158,6 +1158,7 @@ EXPORT_SYMBOL(drm_dp_psr_setup_time);
>  /**
>   * drm_dp_start_crc() - start capture of frame CRCs
>   * @aux: DisplayPort AUX channel
> + * @crtc: CRTC displaying the frames whose CRCs are to be captured
>   *
>   * Returns 0 on success or a negative error code on failure.
>   */
> -- 
> 2.9.3
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Jani Nikula March 8, 2017, 8:39 a.m. UTC | #2
On Wed, 08 Mar 2017, Sean Paul <seanpaul@chromium.org> wrote:
> On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
>> Gabriel Krisman reported these warnings when building the documentation:
>> 
>>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
>> for parameter 'crtc'
>> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
>> for parameter 'crtc'
>> 
>
> I've now added htmldocs build to my pre-merge build testing so I'll hopefully
> catch this earlier (no promises).

Dear 0day folks, what's the status of 'make htmldocs' build testing on
patches posted to dri-devel and intel-gfx mailing lists? I see
occasional mails reporting issues in documentation, but sometimes there
are no reports.

And while I'm reaching out, have we ensured testing of the new repos and
branches we have? There's the drm-misc and drm-tip repos. drm-tip is an
integration tree, and other repos and branches feed to it. If you don't
have anything such, we should probably discuss whether it's best to test
the individual trees, or the integration tree, or both.


BR,
Jani.
Jani Nikula March 8, 2017, 8:41 a.m. UTC | #3
On Wed, 08 Mar 2017, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> On Wed, 08 Mar 2017, Sean Paul <seanpaul@chromium.org> wrote:
>> On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
>>> Gabriel Krisman reported these warnings when building the documentation:
>>> 
>>>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
>>> for parameter 'crtc'
>>> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
>>> for parameter 'crtc'
>>> 
>>
>> I've now added htmldocs build to my pre-merge build testing so I'll hopefully
>> catch this earlier (no promises).
>
> Dear 0day folks, what's the status of 'make htmldocs' build testing on
> patches posted to dri-devel and intel-gfx mailing lists? I see
> occasional mails reporting issues in documentation, but sometimes there
> are no reports.
>
> And while I'm reaching out, have we ensured testing of the new repos and
> branches we have? There's the drm-misc and drm-tip repos. drm-tip is an
> integration tree, and other repos and branches feed to it. If you don't
> have anything such, we should probably discuss whether it's best to test
> the individual trees, or the integration tree, or both.

Okay, I see that you've sent reports about drm-tip, but there's nothing
on the drm-misc branches after it moved from drm-intel.git to a repo of
its own. Is drm-tip enough, or should we expand on drm-misc?

BR,
Jani.

>
>
> BR,
> Jani.
Li, Philip March 8, 2017, 9:20 a.m. UTC | #4
On Wed, Mar 08, 2017 at 10:41:37AM +0200, Jani Nikula wrote:
> On Wed, 08 Mar 2017, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> > On Wed, 08 Mar 2017, Sean Paul <seanpaul@chromium.org> wrote:
> >> On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
> >>> Gabriel Krisman reported these warnings when building the documentation:
> >>> 
> >>>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
> >>> for parameter 'crtc'
> >>> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
> >>> for parameter 'crtc'
> >>> 
> >>
> >> I've now added htmldocs build to my pre-merge build testing so I'll hopefully
> >> catch this earlier (no promises).
> >
> > Dear 0day folks, what's the status of 'make htmldocs' build testing on
> > patches posted to dri-devel and intel-gfx mailing lists? I see
> > occasional mails reporting issues in documentation, but sometimes there
> > are no reports.
> >
> > And while I'm reaching out, have we ensured testing of the new repos and
> > branches we have? There's the drm-misc and drm-tip repos. drm-tip is an
> > integration tree, and other repos and branches feed to it. If you don't
> > have anything such, we should probably discuss whether it's best to test
> > the individual trees, or the integration tree, or both.
> 
> Okay, I see that you've sent reports about drm-tip, but there's nothing
> on the drm-misc branches after it moved from drm-intel.git to a repo of
> its own. Is drm-tip enough, or should we expand on drm-misc?
hi Jani, currently we had covered several drm repos (list a few of them below).
Can you share me the url of drm-misc, probably it is not covered yet.

git://anongit.freedesktop.org/drm/drm-tip
git://anongit.freedesktop.org/drm-intel
git://people.freedesktop.org/~jani/drm

> 
> BR,
> Jani.
> 
> >
> >
> > BR,
> > Jani.
> 
> -- 
> Jani Nikula, Intel Open Source Technology Center
> _______________________________________________
> kbuild-all mailing list
> kbuild-all@lists.01.org
> https://lists.01.org/mailman/listinfo/kbuild-all
Fengguang Wu March 8, 2017, 9:24 a.m. UTC | #5
Hi Jani,

On Wed, Mar 08, 2017 at 10:41:37AM +0200, Jani Nikula wrote:
>On Wed, 08 Mar 2017, Jani Nikula <jani.nikula@linux.intel.com> wrote:
>> On Wed, 08 Mar 2017, Sean Paul <seanpaul@chromium.org> wrote:
>>> On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
>>>> Gabriel Krisman reported these warnings when building the documentation:
>>>>
>>>>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
>>>> for parameter 'crtc'
>>>> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
>>>> for parameter 'crtc'
>>>>
>>>
>>> I've now added htmldocs build to my pre-merge build testing so I'll hopefully
>>> catch this earlier (no promises).
>>
>> Dear 0day folks, what's the status of 'make htmldocs' build testing on
>> patches posted to dri-devel and intel-gfx mailing lists? I see
>> occasional mails reporting issues in documentation, but sometimes there
>> are no reports.
>>
>> And while I'm reaching out, have we ensured testing of the new repos and
>> branches we have? There's the drm-misc and drm-tip repos. drm-tip is an
>> integration tree, and other repos and branches feed to it. If you don't
>> have anything such, we should probably discuss whether it's best to test
>> the individual trees, or the integration tree, or both.
>
>Okay, I see that you've sent reports about drm-tip, but there's nothing
>on the drm-misc branches after it moved from drm-intel.git to a repo of
>its own. Is drm-tip enough, or should we expand on drm-misc?

In 0day testing POV, we'd like to cover all tree/branches as well as
mailing lists. The extra costs are not a big deal to us. If we missed
some coverage, it may be we are not aware of the tree or mailing list,
or something abnormal happened (eg. bugs in the robot or failed to
fetch new code, etc.).

If you think some tree/branch or mailing list should be tested, just
tell us the URL etc. If that's already in our coverage, it may help to
tell us the exact patch/commit that has problem, so that we can try to
find the root cause.

Thanks,
Fengguang

Patch
diff mbox

diff --git a/drivers/gpu/drm/drm_dp_helper.c b/drivers/gpu/drm/drm_dp_helper.c
index c40cfe2e63ab..3e5f52110ea1 100644
--- a/drivers/gpu/drm/drm_dp_helper.c
+++ b/drivers/gpu/drm/drm_dp_helper.c
@@ -1158,6 +1158,7 @@  EXPORT_SYMBOL(drm_dp_psr_setup_time);
 /**
  * drm_dp_start_crc() - start capture of frame CRCs
  * @aux: DisplayPort AUX channel
+ * @crtc: CRTC displaying the frames whose CRCs are to be captured
  *
  * Returns 0 on success or a negative error code on failure.
  */