2022-07-13 08:15:24

by Mauro Carvalho Chehab

Subject: [PATCH v2 17/39] drm/i915: skl_scaler: fix return value kernel-doc markup

The way it is, it produces this warning:

Documentation/gpu/i915:150: ./drivers/gpu/drm/i915/display/skl_scaler.c:213: WARNING: Block quote ends without a blank line; unexpected unindent.

Use list markups to suppress the warning.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v2 00/39] at: https://lore.kernel.org/all/[email protected]/

drivers/gpu/drm/i915/display/skl_scaler.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/gpu/drm/i915/display/skl_scaler.c b/drivers/gpu/drm/i915/display/skl_scaler.c
index 4092679be21e..59099f793d3e 100644
--- a/drivers/gpu/drm/i915/display/skl_scaler.c
+++ b/drivers/gpu/drm/i915/display/skl_scaler.c
@@ -208,9 +208,9 @@ int skl_update_scaler_crtc(struct intel_crtc_state *crtc_state)
* @crtc_state: crtc's scaler state
* @plane_state: atomic plane state to update
*
- * Return
- * 0 - scaler_usage updated successfully
- * error - requested scaling cannot be supported or other error condition
+ * Return:
+ * * 0 - scaler_usage updated successfully
+ * * error - requested scaling cannot be supported or other error condition
*/
int skl_update_scaler_plane(struct intel_crtc_state *crtc_state,
struct intel_plane_state *plane_state)
--
2.36.1

2022-07-15 21:55:00

by Rodrigo Vivi

Subject: Re: [PATCH v2 17/39] drm/i915: skl_scaler: fix return value kernel-doc markup

On Wed, Jul 13, 2022 at 09:12:05AM +0100, Mauro Carvalho Chehab wrote:
> The way it is, it produces this warning:
>
> Documentation/gpu/i915:150: ./drivers/gpu/drm/i915/display/skl_scaler.c:213: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Use list markups to suppress the warning.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Reviewed-by: Rodrigo Vivi <[email protected]>

> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/[email protected]/
>
> drivers/gpu/drm/i915/display/skl_scaler.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/gpu/drm/i915/display/skl_scaler.c b/drivers/gpu/drm/i915/display/skl_scaler.c
> index 4092679be21e..59099f793d3e 100644
> --- a/drivers/gpu/drm/i915/display/skl_scaler.c
> +++ b/drivers/gpu/drm/i915/display/skl_scaler.c
> @@ -208,9 +208,9 @@ int skl_update_scaler_crtc(struct intel_crtc_state *crtc_state)
> * @crtc_state: crtc's scaler state
> * @plane_state: atomic plane state to update
> *
> - * Return
> - * 0 - scaler_usage updated successfully
> - * error - requested scaling cannot be supported or other error condition
> + * Return:
> + * * 0 - scaler_usage updated successfully
> + * * error - requested scaling cannot be supported or other error condition
> */
> int skl_update_scaler_plane(struct intel_crtc_state *crtc_state,
> struct intel_plane_state *plane_state)
> --
> 2.36.1
>