Re: [Intel-gfx] [drm-intel:for-linux-next-fixes 3/4] DockBook: drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'

2015-10-01 Thread Jani Nikula 
On Wed, 30 Sep 2015, Egbert Eich  wrote:
> Jani Nikula writes:
>  > On Wed, 30 Sep 2015, Daniel Vetter  wrote:
>  > > On Wed, Sep 30, 2015 at 05:09:04PM +0800, kbuild test robot wrote:
>  > >> tree:   git://anongit.freedesktop.org/drm-intel for-linux-next-fixes
>  > >> head:   ad96c5f13442b17fafccc30f81efae2f08351f99
>  > >> commit: 10d3a5618b3aba24d6388ccdff2d0182b72a6e8d [3/4] drm: Add a 
> non-locking version of drm_kms_helper_poll_enable(), v2
>  > >> reproduce: make htmldocs
>  > >> 
>  > >> All warnings (new ones prefixed by >>):
>  > 
>  > Cc: Jonathan and Danilo, and including the kernel-doc in question for
>  > reference:
>  > 
>  > /**
>  >  * drm_kms_helper_poll_enable_locked - re-enable output polling.
>  >  * @dev: drm_device
>  >  *
>  >  * This function re-enables the output polling work without
>  >  * locking the mode_config mutex.
>  >  *
>  >  * This is like drm_kms_helper_poll_enable() however it is to be
>  >  * called from a context where the mode_config mutex is locked
>  >  * already.
>  >  */
>  > #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
>  > void drm_kms_helper_poll_enable_locked(struct drm_device *dev)
>  > {
>  >...
>  > 
>  > >> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
>  > >> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
>  > >
>  > > I think this should be fixed by moving the DRM_OUTPUT_POLL_PERIOD #define
>  > > before the kerneldoc for drm_kms_helper_poll_enable_locked. Jani, can you
>  > > please do that fixup and check that make htmldocs is happy with it?
>  > 
>  > Can do.
>  > 
>  > However, having such #defines right above the only function that uses
>  > them is not uncommon. Since there is no documentation for
>  > DRM_OUTPUT_POLL_PERIOD, and the documentation for the function includes
>  > the function name, I am wondering if kernel-doc could be made smarter
>  > about this.
>  > 
>
> It is actually used twice in this file by two functions not immediately 
> adjacent.
> Why not move it to the beginning of the file?

That would've been better, however I was too quick to fix it already
like Daniel suggested.

BR,
Jani.

>
> Cheers,
>   Egbert.

-- 
Jani Nikula, Intel Open Source Technology Center
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx

[Intel-gfx] [drm-intel:for-linux-next-fixes 3/4] DockBook: drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'

2015-09-30 Thread kbuild test robot 
tree:   git://anongit.freedesktop.org/drm-intel for-linux-next-fixes
head:   ad96c5f13442b17fafccc30f81efae2f08351f99
commit: 10d3a5618b3aba24d6388ccdff2d0182b72a6e8d [3/4] drm: Add a non-locking 
version of drm_kms_helper_poll_enable(), v2
reproduce: make htmldocs

All warnings (new ones prefixed by >>):

   drivers/gpu/drm/i915/i915_irq.c:491: warning: No description found for 
parameter 'dev'
   drivers/gpu/drm/i915/i915_irq.c:2217: warning: No description found for 
parameter 'dev'
   drivers/gpu/drm/i915/i915_irq.c:2397: warning: No description found for 
parameter 'wedged'
   drivers/gpu/drm/i915/i915_irq.c:2397: warning: No description found for 
parameter 'fmt'
   include/drm/drm_crtc.h:310: warning: No description found for parameter 
'mode_blob'
   include/drm/drm_crtc.h:748: warning: No description found for parameter 
'tile_blob_ptr'
   include/drm/drm_crtc.h:787: warning: No description found for parameter 
'rotation'
   include/drm/drm_crtc.h:883: warning: No description found for parameter 
'mutex'
   include/drm/drm_crtc.h:883: warning: No description found for parameter 
'helper_private'
   include/drm/drm_crtc.h:931: warning: Excess struct/union/enum/typedef member 
'base' description in 'drm_bridge'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tile_idr'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'delayed_event'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'edid_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'dpms_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'path_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tile_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'plane_type_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'rotation_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_src_x'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_src_y'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_src_w'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_src_h'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_crtc_x'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_crtc_y'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_crtc_w'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_crtc_h'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_fb_id'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_crtc_id'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_active'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'prop_mode_id'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'dvi_i_subconnector_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'dvi_i_select_subconnector_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_subconnector_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_select_subconnector_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_mode_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_left_margin_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_right_margin_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_top_margin_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_bottom_margin_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_brightness_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_contrast_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_flicker_reduction_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_overscan_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_saturation_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'tv_hue_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'scaling_mode_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'aspect_ratio_property'
   include/drm/drm_crtc.h:1169: warning: No description found for parameter 
'dirty_info_property'
   include/drm/drm_crtc.h:1169: warning: No description found for

Re: [Intel-gfx] [drm-intel:for-linux-next-fixes 3/4] DockBook: drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'

2015-09-30 Thread Jani Nikula 
On Wed, 30 Sep 2015, Daniel Vetter  wrote:
> On Wed, Sep 30, 2015 at 05:09:04PM +0800, kbuild test robot wrote:
>> tree:   git://anongit.freedesktop.org/drm-intel for-linux-next-fixes
>> head:   ad96c5f13442b17fafccc30f81efae2f08351f99
>> commit: 10d3a5618b3aba24d6388ccdff2d0182b72a6e8d [3/4] drm: Add a 
>> non-locking version of drm_kms_helper_poll_enable(), v2
>> reproduce: make htmldocs
>> 
>> All warnings (new ones prefixed by >>):

Cc: Jonathan and Danilo, and including the kernel-doc in question for
reference:

/**
 * drm_kms_helper_poll_enable_locked - re-enable output polling.
 * @dev: drm_device
 *
 * This function re-enables the output polling work without
 * locking the mode_config mutex.
 *
 * This is like drm_kms_helper_poll_enable() however it is to be
 * called from a context where the mode_config mutex is locked
 * already.
 */
#define DRM_OUTPUT_POLL_PERIOD (10*HZ)
void drm_kms_helper_poll_enable_locked(struct drm_device *dev)
{
...

>> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
>> >> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
>> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
>> >> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
>
> I think this should be fixed by moving the DRM_OUTPUT_POLL_PERIOD #define
> before the kerneldoc for drm_kms_helper_poll_enable_locked. Jani, can you
> please do that fixup and check that make htmldocs is happy with it?

Can do.

However, having such #defines right above the only function that uses
them is not uncommon. Since there is no documentation for
DRM_OUTPUT_POLL_PERIOD, and the documentation for the function includes
the function name, I am wondering if kernel-doc could be made smarter
about this.


BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [Intel-gfx] [drm-intel:for-linux-next-fixes 3/4] DockBook: drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'

2015-09-30 Thread Daniel Vetter 
On Wed, Sep 30, 2015 at 05:09:04PM +0800, kbuild test robot wrote:
> tree:   git://anongit.freedesktop.org/drm-intel for-linux-next-fixes
> head:   ad96c5f13442b17fafccc30f81efae2f08351f99
> commit: 10d3a5618b3aba24d6388ccdff2d0182b72a6e8d [3/4] drm: Add a non-locking 
> version of drm_kms_helper_poll_enable(), v2
> reproduce: make htmldocs
> 
> All warnings (new ones prefixed by >>):
> 
>drivers/gpu/drm/i915/i915_irq.c:491: warning: No description found for 
> parameter 'dev'
>drivers/gpu/drm/i915/i915_irq.c:2217: warning: No description found for 
> parameter 'dev'
>drivers/gpu/drm/i915/i915_irq.c:2397: warning: No description found for 
> parameter 'wedged'
>drivers/gpu/drm/i915/i915_irq.c:2397: warning: No description found for 
> parameter 'fmt'
>include/drm/drm_crtc.h:310: warning: No description found for parameter 
> 'mode_blob'
>include/drm/drm_crtc.h:748: warning: No description found for parameter 
> 'tile_blob_ptr'
>include/drm/drm_crtc.h:787: warning: No description found for parameter 
> 'rotation'
>include/drm/drm_crtc.h:883: warning: No description found for parameter 
> 'mutex'
>include/drm/drm_crtc.h:883: warning: No description found for parameter 
> 'helper_private'
>include/drm/drm_crtc.h:931: warning: Excess struct/union/enum/typedef 
> member 'base' description in 'drm_bridge'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tile_idr'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'delayed_event'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'edid_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'dpms_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'path_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tile_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'plane_type_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'rotation_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_src_x'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_src_y'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_src_w'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_src_h'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_crtc_x'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_crtc_y'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_crtc_w'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_crtc_h'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_fb_id'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_crtc_id'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_active'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'prop_mode_id'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'dvi_i_subconnector_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'dvi_i_select_subconnector_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_subconnector_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_select_subconnector_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_mode_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_left_margin_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_right_margin_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_top_margin_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_bottom_margin_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_brightness_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_contrast_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_flicker_reduction_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_overscan_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_saturation_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'tv_hue_property'
>include/drm/drm_crtc.h:1169: warning: No description found for parameter 
> 'scaling_mode_property'

Re: [Intel-gfx] [drm-intel:for-linux-next-fixes 3/4] DockBook: drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'

2015-09-30 Thread Egbert Eich 
Jani Nikula writes:
 > On Wed, 30 Sep 2015, Daniel Vetter  wrote:
 > > On Wed, Sep 30, 2015 at 05:09:04PM +0800, kbuild test robot wrote:
 > >> tree:   git://anongit.freedesktop.org/drm-intel for-linux-next-fixes
 > >> head:   ad96c5f13442b17fafccc30f81efae2f08351f99
 > >> commit: 10d3a5618b3aba24d6388ccdff2d0182b72a6e8d [3/4] drm: Add a 
 > >> non-locking version of drm_kms_helper_poll_enable(), v2
 > >> reproduce: make htmldocs
 > >> 
 > >> All warnings (new ones prefixed by >>):
 > 
 > Cc: Jonathan and Danilo, and including the kernel-doc in question for
 > reference:
 > 
 > /**
 >  * drm_kms_helper_poll_enable_locked - re-enable output polling.
 >  * @dev: drm_device
 >  *
 >  * This function re-enables the output polling work without
 >  * locking the mode_config mutex.
 >  *
 >  * This is like drm_kms_helper_poll_enable() however it is to be
 >  * called from a context where the mode_config mutex is locked
 >  * already.
 >  */
 > #define DRM_OUTPUT_POLL_PERIOD (10*HZ)
 > void drm_kms_helper_poll_enable_locked(struct drm_device *dev)
 > {
 >  ...
 > 
 > >> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
 > >> >> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
 > >> >> drivers/gpu/drm/drm_probe_helper.c:107: warning: Excess function 
 > >> >> parameter 'dev' description in 'DRM_OUTPUT_POLL_PERIOD'
 > >
 > > I think this should be fixed by moving the DRM_OUTPUT_POLL_PERIOD #define
 > > before the kerneldoc for drm_kms_helper_poll_enable_locked. Jani, can you
 > > please do that fixup and check that make htmldocs is happy with it?
 > 
 > Can do.
 > 
 > However, having such #defines right above the only function that uses
 > them is not uncommon. Since there is no documentation for
 > DRM_OUTPUT_POLL_PERIOD, and the documentation for the function includes
 > the function name, I am wondering if kernel-doc could be made smarter
 > about this.
 > 

It is actually used twice in this file by two functions not immediately 
adjacent.
Why not move it to the beginning of the file?

Cheers,
Egbert.
___
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx