Re: [PATCH] staging: sm750: Rename camel case functions

From: Julia Lawall
Date: Sat Mar 11 2023 - 01:12:46 EST



On Sat, 11 Mar 2023, Kloudifold wrote:

> This patch fixes the "CHECK: Avoid CamelCase" reported by
> checkpatch.pl by renaming camel case functions in
> sm750_cursor.c and sm750_cursor.h.
> Modified calls to functions declared in sm750_cursor.h in sm750.c.

Kloudifold,

Please go back and read the entire Outreachy patch tutorial. It explains
clearly how to update a patch when you have gotten some feedback about it.
It also explains how to write a good log message.

With respect to your log message here, you never need to say "This patch".
It's clear that wat you are talking about a patch. Please try to avoid
the word "fix". As in this case, it naturally leads one to not actually
explaining what is done. It is useful to acknowledge that checkpatch
helped you find the problem, and perhaps useful to provide the checkpatch
warning, but put all that at the end. Explain what you have done and why
first, because that is most interesting to the reader. There is no need
to mention the file names in the log message. That information is easily
available in the diffstat below. And the log message should be written in
the imperative (eg Modify) not the past tense (Modified).

You may find it helpful to look at other patches (git log -p) to get a
feel for the expected style.

julia


>
> Fixed issue in [PATCH] staging: sm750: Rename camel case functions in sm750_cursor.*
> | Reported-by: kernel test robot <lkp@xxxxxxxxx>
> | Link: https://lore.kernel.org/oe-kbuild-all/202303110849.X24WnHnM-lkp@xxxxxxxxx/
>
> Signed-off-by: Kloudifold <cloudifold.3125@xxxxxxxxx>
> ---
> drivers/staging/sm750fb/sm750.c | 22 +++++++++++-----------
> drivers/staging/sm750fb/sm750_cursor.c | 14 +++++++-------
> drivers/staging/sm750fb/sm750_cursor.h | 12 ++++++------
> 3 files changed, 24 insertions(+), 24 deletions(-)
>
> diff --git a/drivers/staging/sm750fb/sm750.c b/drivers/staging/sm750fb/sm750.c
> index effc7fcc3..5d7249e82 100644
> --- a/drivers/staging/sm750fb/sm750.c
> +++ b/drivers/staging/sm750fb/sm750.c
> @@ -121,14 +121,14 @@ static int lynxfb_ops_cursor(struct fb_info *info, struct fb_cursor *fbcursor)
>
> sm750_hw_cursor_disable(cursor);
> if (fbcursor->set & FB_CUR_SETSIZE)
> - sm750_hw_cursor_setSize(cursor,
> - fbcursor->image.width,
> - fbcursor->image.height);
> + sm750_hw_cursor_set_size(cursor,
> + fbcursor->image.width,
> + fbcursor->image.height);
>
> if (fbcursor->set & FB_CUR_SETPOS)
> - sm750_hw_cursor_setPos(cursor,
> - fbcursor->image.dx - info->var.xoffset,
> - fbcursor->image.dy - info->var.yoffset);
> + sm750_hw_cursor_set_pos(cursor,
> + fbcursor->image.dx - info->var.xoffset,
> + fbcursor->image.dy - info->var.yoffset);
>
> if (fbcursor->set & FB_CUR_SETCMAP) {
> /* get the 16bit color of kernel means */
> @@ -142,14 +142,14 @@ static int lynxfb_ops_cursor(struct fb_info *info, struct fb_cursor *fbcursor)
> ((info->cmap.green[fbcursor->image.bg_color] & 0xfc00) >> 5) |
> ((info->cmap.blue[fbcursor->image.bg_color] & 0xf800) >> 11);
>
> - sm750_hw_cursor_setColor(cursor, fg, bg);
> + sm750_hw_cursor_set_color(cursor, fg, bg);
> }
>
> if (fbcursor->set & (FB_CUR_SETSHAPE | FB_CUR_SETIMAGE)) {
> - sm750_hw_cursor_setData(cursor,
> - fbcursor->rop,
> - fbcursor->image.data,
> - fbcursor->mask);
> + sm750_hw_cursor_set_data(cursor,
> + fbcursor->rop,
> + fbcursor->image.data,
> + fbcursor->mask);
> }
>
> if (fbcursor->enable)
> diff --git a/drivers/staging/sm750fb/sm750_cursor.c b/drivers/staging/sm750fb/sm750_cursor.c
> index 43e6f52c2..ff643e33f 100644
> --- a/drivers/staging/sm750fb/sm750_cursor.c
> +++ b/drivers/staging/sm750fb/sm750_cursor.c
> @@ -58,13 +58,13 @@ void sm750_hw_cursor_disable(struct lynx_cursor *cursor)
> poke32(HWC_ADDRESS, 0);
> }
>
> -void sm750_hw_cursor_setSize(struct lynx_cursor *cursor, int w, int h)
> +void sm750_hw_cursor_set_size(struct lynx_cursor *cursor, int w, int h)
> {
> cursor->w = w;
> cursor->h = h;
> }
>
> -void sm750_hw_cursor_setPos(struct lynx_cursor *cursor, int x, int y)
> +void sm750_hw_cursor_set_pos(struct lynx_cursor *cursor, int x, int y)
> {
> u32 reg;
>
> @@ -73,7 +73,7 @@ void sm750_hw_cursor_setPos(struct lynx_cursor *cursor, int x, int y)
> poke32(HWC_LOCATION, reg);
> }
>
> -void sm750_hw_cursor_setColor(struct lynx_cursor *cursor, u32 fg, u32 bg)
> +void sm750_hw_cursor_set_color(struct lynx_cursor *cursor, u32 fg, u32 bg)
> {
> u32 reg = (fg << HWC_COLOR_12_2_RGB565_SHIFT) &
> HWC_COLOR_12_2_RGB565_MASK;
> @@ -82,8 +82,8 @@ void sm750_hw_cursor_setColor(struct lynx_cursor *cursor, u32 fg, u32 bg)
> poke32(HWC_COLOR_3, 0xffe0);
> }
>
> -void sm750_hw_cursor_setData(struct lynx_cursor *cursor, u16 rop,
> - const u8 *pcol, const u8 *pmsk)
> +void sm750_hw_cursor_set_data(struct lynx_cursor *cursor, u16 rop,
> + const u8 *pcol, const u8 *pmsk)
> {
> int i, j, count, pitch, offset;
> u8 color, mask, opr;
> @@ -132,8 +132,8 @@ void sm750_hw_cursor_setData(struct lynx_cursor *cursor, u16 rop,
> }
> }
>
> -void sm750_hw_cursor_setData2(struct lynx_cursor *cursor, u16 rop,
> - const u8 *pcol, const u8 *pmsk)
> +void sm750_hw_cursor_set_data2(struct lynx_cursor *cursor, u16 rop,
> + const u8 *pcol, const u8 *pmsk)
> {
> int i, j, count, pitch, offset;
> u8 color, mask;
> diff --git a/drivers/staging/sm750fb/sm750_cursor.h b/drivers/staging/sm750fb/sm750_cursor.h
> index b59643dd6..88fa02f63 100644
> --- a/drivers/staging/sm750fb/sm750_cursor.h
> +++ b/drivers/staging/sm750fb/sm750_cursor.h
> @@ -5,11 +5,11 @@
> /* hw_cursor_xxx works for voyager,718 and 750 */
> void sm750_hw_cursor_enable(struct lynx_cursor *cursor);
> void sm750_hw_cursor_disable(struct lynx_cursor *cursor);
> -void sm750_hw_cursor_setSize(struct lynx_cursor *cursor, int w, int h);
> -void sm750_hw_cursor_setPos(struct lynx_cursor *cursor, int x, int y);
> -void sm750_hw_cursor_setColor(struct lynx_cursor *cursor, u32 fg, u32 bg);
> -void sm750_hw_cursor_setData(struct lynx_cursor *cursor, u16 rop,
> - const u8 *data, const u8 *mask);
> -void sm750_hw_cursor_setData2(struct lynx_cursor *cursor, u16 rop,
> +void sm750_hw_cursor_set_size(struct lynx_cursor *cursor, int w, int h);
> +void sm750_hw_cursor_set_pos(struct lynx_cursor *cursor, int x, int y);
> +void sm750_hw_cursor_set_color(struct lynx_cursor *cursor, u32 fg, u32 bg);
> +void sm750_hw_cursor_set_data(struct lynx_cursor *cursor, u16 rop,
> const u8 *data, const u8 *mask);
> +void sm750_hw_cursor_set_data2(struct lynx_cursor *cursor, u16 rop,
> + const u8 *data, const u8 *mask);
> #endif
> --
> 2.39.2
>
>
>