Re: [PATCH 4/4] drm/doc: Appease sphinx

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, 02 Jun 2016, Daniel Vetter <daniel.vetter@xxxxxxxx> wrote:
> Mostly this is unexpected indents. But really it's just a
> demonstration for my patch, all these issues have been found&fixed
> using the correct source file and line number support I just added.
> All line numbers have been perfectly accurate.
>
> One issue looked a bit fishy in intel_lrc.c, where I don't quite grok
> what sphinx is unhappy about. But since that file looks like it has
> never seen a proper kernel-doc parser I figured better to fix in a
> separate path.
>
> Cc: Jani Nikula <jani.nikula@xxxxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxxx>
> ---
>  drivers/gpu/drm/drm_atomic_helper.c |  2 +-
>  drivers/gpu/drm/drm_crtc.c          |  2 +-
>  drivers/gpu/drm/drm_gem.c           |  2 +-
>  drivers/gpu/drm/drm_modes.c         |  1 +
>  drivers/gpu/drm/drm_plane_helper.c  | 10 ++++++----
>  drivers/gpu/drm/i915/intel_dp.c     | 16 ++++++++--------
>  drivers/gpu/drm/i915/intel_fbc.c    |  3 ++-
>  7 files changed, 20 insertions(+), 16 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_atomic_helper.c b/drivers/gpu/drm/drm_atomic_helper.c
> index 59d8ee2c01e8..2d02ef0340f3 100644
> --- a/drivers/gpu/drm/drm_atomic_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_helper.c
> @@ -2794,7 +2794,7 @@ EXPORT_SYMBOL(drm_atomic_helper_page_flip);
>   * This is the main helper function provided by the atomic helper framework for
>   * implementing the legacy DPMS connector interface. It computes the new desired
>   * ->active state for the corresponding CRTC (if the connector is enabled) and
> - *  updates it.
> + * updates it.
>   *
>   * Returns:
>   * Returns 0 on success, negative errno numbers on failure.
> diff --git a/drivers/gpu/drm/drm_crtc.c b/drivers/gpu/drm/drm_crtc.c
> index 9e4bc06361ba..d92193469eb9 100644
> --- a/drivers/gpu/drm/drm_crtc.c
> +++ b/drivers/gpu/drm/drm_crtc.c
> @@ -535,7 +535,7 @@ EXPORT_SYMBOL(drm_framebuffer_unregister_private);
>   *
>   * Cleanup framebuffer. This function is intended to be used from the drivers
>   * ->destroy callback. It can also be used to clean up driver private
> - *  framebuffers embedded into a larger structure.
> + * framebuffers embedded into a larger structure.
>   *
>   * Note that this function does not remove the fb from active usuage - if it is
>   * still used anywhere, hilarity can ensue since userspace could call getfb on
> diff --git a/drivers/gpu/drm/drm_gem.c b/drivers/gpu/drm/drm_gem.c
> index 32156060b9c9..5349322b7b30 100644
> --- a/drivers/gpu/drm/drm_gem.c
> +++ b/drivers/gpu/drm/drm_gem.c
> @@ -787,7 +787,7 @@ EXPORT_SYMBOL(drm_gem_object_release);
>   * @kref: kref of the object to free
>   *
>   * Called after the last reference to the object has been lost.
> - * Must be called holding struct_ mutex
> + * Must be called holding dev->struct_mutex.

If you want to be fancy, you can now use &drm_device->struct_mutex,
which will create a link to drm_device definition.

Regardless,

Reviewed-by: Jani Nikula <jani.nikula@xxxxxxxxx>


>   *
>   * Frees the object
>   */
> diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
> index 1eb679e5fbb1..fc5040ae5f25 100644
> --- a/drivers/gpu/drm/drm_modes.c
> +++ b/drivers/gpu/drm/drm_modes.c
> @@ -544,6 +544,7 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
>   *
>   * This function is to create the modeline based on the GTF algorithm.
>   * Generalized Timing Formula is derived from:
> + *
>   *	GTF Spreadsheet by Andy Morrish (1/5/97)
>   *	available at http://www.vesa.org
>   *
> diff --git a/drivers/gpu/drm/drm_plane_helper.c b/drivers/gpu/drm/drm_plane_helper.c
> index 369d2898ff9e..fc51306fe365 100644
> --- a/drivers/gpu/drm/drm_plane_helper.c
> +++ b/drivers/gpu/drm/drm_plane_helper.c
> @@ -219,10 +219,12 @@ EXPORT_SYMBOL(drm_plane_helper_check_update);
>   *
>   * Note that we make some assumptions about hardware limitations that may not be
>   * true for all hardware --
> - *   1) Primary plane cannot be repositioned.
> - *   2) Primary plane cannot be scaled.
> - *   3) Primary plane must cover the entire CRTC.
> - *   4) Subpixel positioning is not supported.
> + *
> + * 1. Primary plane cannot be repositioned.
> + * 2. Primary plane cannot be scaled.
> + * 3. Primary plane must cover the entire CRTC.
> + * 4. Subpixel positioning is not supported.
> + *
>   * Drivers for hardware that don't have these restrictions can provide their
>   * own implementation rather than using this helper.
>   *
> diff --git a/drivers/gpu/drm/i915/intel_dp.c b/drivers/gpu/drm/i915/intel_dp.c
> index 7dfff877fb55..e074341d46bf 100644
> --- a/drivers/gpu/drm/i915/intel_dp.c
> +++ b/drivers/gpu/drm/i915/intel_dp.c
> @@ -5235,14 +5235,14 @@ void intel_edp_drrs_flush(struct drm_device *dev,
>   *
>   * DRRS saves power by switching to low RR based on usage scenarios.
>   *
> - * eDP DRRS:-
> - *        The implementation is based on frontbuffer tracking implementation.
> - * When there is a disturbance on the screen triggered by user activity or a
> - * periodic system activity, DRRS is disabled (RR is changed to high RR).
> - * When there is no movement on screen, after a timeout of 1 second, a switch
> - * to low RR is made.
> - *        For integration with frontbuffer tracking code,
> - * intel_edp_drrs_invalidate() and intel_edp_drrs_flush() are called.
> + * The implementation is based on frontbuffer tracking implementation.  When
> + * there is a disturbance on the screen triggered by user activity or a periodic
> + * system activity, DRRS is disabled (RR is changed to high RR).  When there is
> + * no movement on screen, after a timeout of 1 second, a switch to low RR is
> + * made.
> + *
> + * For integration with frontbuffer tracking code, intel_edp_drrs_invalidate()
> + * and intel_edp_drrs_flush() are called.
>   *
>   * DRRS can be further extended to support other internal panels and also
>   * the scenario of video playback wherein RR is set based on the rate
> diff --git a/drivers/gpu/drm/i915/intel_fbc.c b/drivers/gpu/drm/i915/intel_fbc.c
> index 0dea5fbcd8aa..45ee07b888a0 100644
> --- a/drivers/gpu/drm/i915/intel_fbc.c
> +++ b/drivers/gpu/drm/i915/intel_fbc.c
> @@ -374,8 +374,9 @@ static void intel_fbc_hw_deactivate(struct drm_i915_private *dev_priv)
>   * @dev_priv: i915 device instance
>   *
>   * This function is used to verify the current state of FBC.
> + *
>   * FIXME: This should be tracked in the plane config eventually
> - *        instead of queried at runtime for most callers.
> + * instead of queried at runtime for most callers.
>   */
>  bool intel_fbc_is_active(struct drm_i915_private *dev_priv)
>  {

-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux