drm/atomic-helper: properly annotate functions in kerneldoc
diff mbox

Message ID 1440512763-797-1-git-send-email-daniel.vetter@ffwll.ch
State New
Headers show

Commit Message

Daniel Vetter Aug. 25, 2015, 2:26 p.m. UTC
Without the () the markup and more important hyperlinking wont happen.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 drivers/gpu/drm/drm_atomic_helper.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Laurent Pinchart Aug. 25, 2015, 3 p.m. UTC | #1
Hi Daniel,

Thank you for the patch.

On Tuesday 25 August 2015 16:26:03 Daniel Vetter wrote:
> Without the () the markup and more important hyperlinking wont happen.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  drivers/gpu/drm/drm_atomic_helper.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_atomic_helper.c
> b/drivers/gpu/drm/drm_atomic_helper.c index bc9c94e4cbaa..904acf236f36
> 100644
> --- a/drivers/gpu/drm/drm_atomic_helper.c
> +++ b/drivers/gpu/drm/drm_atomic_helper.c
> @@ -42,14 +42,14 @@
>   * add their own additional internal state.
>   *
>   * This library also provides default implementations for the check
> callback in
> - * drm_atomic_helper_check and for the commit callback with
> - * drm_atomic_helper_commit. But the individual stages and callbacks are
> expose
> + * drm_atomic_helper_check() and for the commit callback with
> + * drm_atomic_helper_commit(). But the individual stages and callbacks are
> expose

While at it, could you fix the typo here with s/expose/exposed/ ?

Apart from that,

Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

>   * to allow drivers to mix and match and e.g. use the plane helpers only
>   * together with a driver private modeset implementation.
>   *
>   * This library also provides implementations for all the legacy driver
> - * interfaces on top of the atomic interface. See
> drm_atomic_helper_set_config,
> - * drm_atomic_helper_disable_plane, drm_atomic_helper_disable_plane and the
> + * interfaces on top of the atomic interface. See
> drm_atomic_helper_set_config(),
> + * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and
> the
> * various functions to implement set_property callbacks. New drivers must
> not
> * implement these functions themselves but must use the provided helpers. */
> @@ -1078,7 +1078,7 @@ EXPORT_SYMBOL(drm_atomic_helper_commit);
>   * work item, which allows nice concurrent updates on disjoint sets of
> crtcs.
>   *
>   * 3. The software state is updated synchronously with
> - * drm_atomic_helper_swap_state. Doing this under the protection of all
> modeset
> + * drm_atomic_helper_swap_state(). Doing this under the protection of all
> modeset
>   * locks means concurrent callers never see inconsistent state. And doing
> this
>   * while it's guaranteed that no relevant async worker runs means that
> async
>   * workers do not need grab any locks. Actually they must not grab locks,
> for
> @@ -1351,7 +1351,7 @@
> EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes); *
>   * 4. Actually commit the hardware state.
>   *
> - * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
> + * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since
> step 3
>   * contains the old state. Also do any other cleanup required with that
> state.
>   */
>  void drm_atomic_helper_swap_state(struct drm_device *dev,
Daniel Vetter Aug. 25, 2015, 3:12 p.m. UTC | #2
On Tue, Aug 25, 2015 at 06:00:26PM +0300, Laurent Pinchart wrote:
> Hi Daniel,
> 
> Thank you for the patch.
> 
> On Tuesday 25 August 2015 16:26:03 Daniel Vetter wrote:
> > Without the () the markup and more important hyperlinking wont happen.
> > 
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> > ---
> >  drivers/gpu/drm/drm_atomic_helper.c | 12 ++++++------
> >  1 file changed, 6 insertions(+), 6 deletions(-)
> > 
> > diff --git a/drivers/gpu/drm/drm_atomic_helper.c
> > b/drivers/gpu/drm/drm_atomic_helper.c index bc9c94e4cbaa..904acf236f36
> > 100644
> > --- a/drivers/gpu/drm/drm_atomic_helper.c
> > +++ b/drivers/gpu/drm/drm_atomic_helper.c
> > @@ -42,14 +42,14 @@
> >   * add their own additional internal state.
> >   *
> >   * This library also provides default implementations for the check
> > callback in
> > - * drm_atomic_helper_check and for the commit callback with
> > - * drm_atomic_helper_commit. But the individual stages and callbacks are
> > expose
> > + * drm_atomic_helper_check() and for the commit callback with
> > + * drm_atomic_helper_commit(). But the individual stages and callbacks are
> > expose
> 
> While at it, could you fix the typo here with s/expose/exposed/ ?
> 
> Apart from that,
> 
> Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Fixed up and patch applied to drm-misc, thanks for the review.
-Daniel

> 
> >   * to allow drivers to mix and match and e.g. use the plane helpers only
> >   * together with a driver private modeset implementation.
> >   *
> >   * This library also provides implementations for all the legacy driver
> > - * interfaces on top of the atomic interface. See
> > drm_atomic_helper_set_config,
> > - * drm_atomic_helper_disable_plane, drm_atomic_helper_disable_plane and the
> > + * interfaces on top of the atomic interface. See
> > drm_atomic_helper_set_config(),
> > + * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and
> > the
> > * various functions to implement set_property callbacks. New drivers must
> > not
> > * implement these functions themselves but must use the provided helpers. */
> > @@ -1078,7 +1078,7 @@ EXPORT_SYMBOL(drm_atomic_helper_commit);
> >   * work item, which allows nice concurrent updates on disjoint sets of
> > crtcs.
> >   *
> >   * 3. The software state is updated synchronously with
> > - * drm_atomic_helper_swap_state. Doing this under the protection of all
> > modeset
> > + * drm_atomic_helper_swap_state(). Doing this under the protection of all
> > modeset
> >   * locks means concurrent callers never see inconsistent state. And doing
> > this
> >   * while it's guaranteed that no relevant async worker runs means that
> > async
> >   * workers do not need grab any locks. Actually they must not grab locks,
> > for
> > @@ -1351,7 +1351,7 @@
> > EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes); *
> >   * 4. Actually commit the hardware state.
> >   *
> > - * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
> > + * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since
> > step 3
> >   * contains the old state. Also do any other cleanup required with that
> > state.
> >   */
> >  void drm_atomic_helper_swap_state(struct drm_device *dev,
> 
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox

diff --git a/drivers/gpu/drm/drm_atomic_helper.c b/drivers/gpu/drm/drm_atomic_helper.c
index bc9c94e4cbaa..904acf236f36 100644
--- a/drivers/gpu/drm/drm_atomic_helper.c
+++ b/drivers/gpu/drm/drm_atomic_helper.c
@@ -42,14 +42,14 @@ 
  * add their own additional internal state.
  *
  * This library also provides default implementations for the check callback in
- * drm_atomic_helper_check and for the commit callback with
- * drm_atomic_helper_commit. But the individual stages and callbacks are expose
+ * drm_atomic_helper_check() and for the commit callback with
+ * drm_atomic_helper_commit(). But the individual stages and callbacks are expose
  * to allow drivers to mix and match and e.g. use the plane helpers only
  * together with a driver private modeset implementation.
  *
  * This library also provides implementations for all the legacy driver
- * interfaces on top of the atomic interface. See drm_atomic_helper_set_config,
- * drm_atomic_helper_disable_plane, drm_atomic_helper_disable_plane and the
+ * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
+ * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
  * various functions to implement set_property callbacks. New drivers must not
  * implement these functions themselves but must use the provided helpers.
  */
@@ -1078,7 +1078,7 @@  EXPORT_SYMBOL(drm_atomic_helper_commit);
  * work item, which allows nice concurrent updates on disjoint sets of crtcs.
  *
  * 3. The software state is updated synchronously with
- * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
+ * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
  * locks means concurrent callers never see inconsistent state. And doing this
  * while it's guaranteed that no relevant async worker runs means that async
  * workers do not need grab any locks. Actually they must not grab locks, for
@@ -1351,7 +1351,7 @@  EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
  *
  * 4. Actually commit the hardware state.
  *
- * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
+ * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
  * contains the old state. Also do any other cleanup required with that state.
  */
 void drm_atomic_helper_swap_state(struct drm_device *dev,