Skip to contentSkip to conversation

drm/format_helper: fix a kernel-doc typo

PATCH In review Randy Dunlap 3 participants 12 messages Apr 3, 2022 – Apr 5, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/format_helper: fix a kernel-doc typo

It looks like the incorrect name of a function parameter was used in the kernel-doc notation, so just change it to the function's parameter name to quell the kernel-doc warning.

drivers/gpu/drm/drm_format_helper.c:640: warning: Function parameter or member 'vaddr' not described in 'drm_fb_xrgb8888_to_mono_reversed' drivers/gpu/drm/drm_format_helper.c:640: warning: Excess function parameter 'src' description in 'drm_fb_xrgb8888_to_mono_reversed'

Fixes bcf8b616deb8 ("drm/format-helper: Add drm_fb_xrgb8888_to_mono_reversed()")
Cc David Airlie <[email protected]>
Cc Daniel Vetter <[email protected]>
Cc Javier Martinez Canillas <[email protected]>
Cc Maarten Lankhorst <[email protected]>
CC Maxime Ripard <[email protected]>
CC Thomas Zimmermann <[email protected]>
---
 drivers/gpu/drm/drm_format_helper.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_format_helper.c +1 -1
@@ -624,7 +624,7 @@ static void drm_fb_gray8_to_mono_reverse
  * drm_fb_xrgb8888_to_mono_reversed - Convert XRGB8888 to reversed monochrome
  * @dst: reversed monochrome destination buffer
  * @dst_pitch: Number of bytes between two consecutive scanlines within dst
- * @src: XRGB8888 source buffer
+ * @vaddr: XRGB8888 source buffer
  * @fb: DRM framebuffer
  * @clip: Clip rectangle area to copy
  *
Reviewed-by on v1 1/1
#2 lore raw
In reply to Randy Dunlap

Hello Randy,

Quoted 16 lines · Randy Dunlap

It looks like the incorrect name of a function parameter was used in the kernel-doc notation, so just change it to the function's parameter name to quell the kernel-doc warning.

drivers/gpu/drm/drm_format_helper.c:640: warning: Function parameter or member 'vaddr' not described in 'drm_fb_xrgb8888_to_mono_reversed' drivers/gpu/drm/drm_format_helper.c:640: warning: Excess function parameter 'src' description in 'drm_fb_xrgb8888_to_mono_reversed'

Fixes bcf8b616deb8 ("drm/format-helper: Add drm_fb_xrgb8888_to_mono_reversed()")
Cc David Airlie <[email protected]>
Cc Daniel Vetter <[email protected]>
Cc Javier Martinez Canillas <[email protected]>
Cc Maarten Lankhorst <[email protected]>
CC Maxime Ripard <[email protected]>
CC Thomas Zimmermann <[email protected]>
Quoted 4 lines
---
 drivers/gpu/drm/drm_format_helper.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thanks for the patch.

Signature · 5 lines
Best regards,

Javier Martinez Canillas
Linux Engineering
Red Hat
#4 lore raw

Hi Simon,

Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

thanks.

Signature · 1 line
~Randy
#5 lore raw
Quoted 8 lines · Randy Dunlap
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

    --- linux-next-20211217.orig/include/drm/drm_file.h
    +++ linux-next-20211217/include/drm/drm_file.h

I changed these to:

    --- a/include/drm/drm_file.h
    +++ b/include/drm/drm_file.h

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

#6 lore raw
Quoted 17 lines · Simon Ser
Quoted 8 lines · Randy Dunlap
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

    --- linux-next-20211217.orig/include/drm/drm_file.h
    +++ linux-next-20211217/include/drm/drm_file.h
Quoted 8 lines

I changed these to:

    --- a/include/drm/drm_file.h
    +++ b/include/drm/drm_file.h

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

Yes, I believe the suggestion should be to use git-format-patch instead.

To make sure that was is posted can be consumed by the git-am command.

Signature · 5 lines
Best regards,

Javier Martinez Canillas
Linux Engineering
Red Hat
#7 lore raw
Quoted 23 lines · Javier Martinez Canillas
Quoted 22 lines · Simon Ser
Quoted 8 lines · Randy Dunlap
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

    --- linux-next-20211217.orig/include/drm/drm_file.h
    +++ linux-next-20211217/include/drm/drm_file.h

I changed these to:

    --- a/include/drm/drm_file.h
    +++ b/include/drm/drm_file.h
Quoted 7 lines
Quoted 3 lines

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

Yes, I believe the suggestion should be to use git-format-patch instead.

To make sure that was is posted can be consumed by the git-am command.

Considering that I am not using git, I think it will be difficult to use git-format-patch.

(git-send-email is independent of git.)

Still, this is the first time in many years that I have heard of this problem.

Thanks for the info and insights.

Signature · 1 line
~Randy
#8 lore raw
Quoted 31 lines · Randy Dunlap
Quoted 29 lines · Javier Martinez Canillas
Quoted 22 lines · Simon Ser
Quoted 8 lines · On Monday, April 4th, 2022 at 23:35, Randy Dunlap [email protected] wrote:
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

include/drm/drm_file.h +0 -0

I changed these to:

include/drm/drm_file.h +0 -0
Quoted 2 lines

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

Yes, I believe the suggestion should be to use git-format-patch instead.

Quoted 5 lines
Quoted 1 line

To make sure that was is posted can be consumed by the git-am command.

Considering that I am not using git, I think it will be difficult to use git-format-patch.

Ah, okay. Would you consider using Git for you next patches?

(FYI, I'll pass next time I hit a patch which doesn't apply cleanly. Nothing personal, it's just that I don't have time to deal with broken patches.)

#9 lore raw

Hi Simon,

Quoted 20 lines · Simon Ser
Quoted 18 lines · Randy Dunlap
Quoted 16 lines · Javier Martinez Canillas
Quoted 14 lines · Simon Ser
Quoted 8 lines · On Monday, April 4th, 2022 at 23:35, Randy Dunlap [email protected] wrote:
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/drm_file.h

Quoted 7 lines
include/drm/drm_file.h +0 -0

I changed these to:

include/drm/drm_file.h +0 -0

quilt (which I am using) can generate a/ b/ patches instead of linux.orig/ and linux/ patches.

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

I would like more information about this one if it's not too much trouble for you.

Quoted 9 lines
Quoted 7 lines
Quoted 3 lines

Yes, I believe the suggestion should be to use git-format-patch instead.

To make sure that was is posted can be consumed by the git-am command.

Considering that I am not using git, I think it will be difficult to use git-format-patch.

Ah, okay. Would you consider using Git for you next patches?

Don't know. It's quite a big hurdle to jump over IMO.

Quoted 3 lines

(FYI, I'll pass next time I hit a patch which doesn't apply cleanly. Nothing personal, it's just that I don't have time to deal with broken patches.)

Yeah, I get it.

thanks.

Signature · 1 line
~Randy
#10 lore raw
Quoted 34 lines · Randy Dunlap
Quoted 20 lines · Simon Ser
Quoted 18 lines · On Tuesday, April 5th, 2022 at 16:39, Randy Dunlap [email protected] wrote:
Quoted 16 lines · Javier Martinez Canillas
Quoted 14 lines · Simon Ser
Quoted 8 lines · On Monday, April 4th, 2022 at 23:35, Randy Dunlap [email protected] wrote:
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/drm_file.h

Quoted 7 lines
include/drm/drm_file.h +0 -0

I changed these to:

include/drm/drm_file.h +0 -0

quilt (which I am using) can generate a/ b/ patches instead of linux.orig/ and linux/ patches.

Quoted 6 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

I would like more information about this one if it's not too much trouble for you.

IIRC it was the usual git-am error "fatal: sha1 information is lacking or useless". Maybe you wrote the patch for an old tree and drm-misc-next contained changes near the lines you changed? Maybe providing base-commit information in the patch would've helped? I'm not sure.

#11 lore raw
Quoted 40 lines · Simon Ser
Quoted 38 lines · Randy Dunlap
Quoted 20 lines · Simon Ser
Quoted 18 lines · On Tuesday, April 5th, 2022 at 16:39, Randy Dunlap [email protected] wrote:
Quoted 16 lines · Javier Martinez Canillas
Quoted 14 lines · Simon Ser
Quoted 8 lines · On Monday, April 4th, 2022 at 23:35, Randy Dunlap [email protected] wrote:
Quoted 3 lines · Simon Ser

Both doc patches pushed, thanks. I had to manually edit them because they wouldn't apply cleanly. Next time, please use git-send-email (see
https://git-send-email.io/ for setup instructions).

That's odd. I did use 'git send-email' and I don't usually have any problems (AFAIK). I'll check those setup instructions.

Hm, maybe the issue isn't git-send-email, but the way the patch was generated? I had to manually edit these lines for the first patch to work:

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

include/drm/drm_file.h

Quoted 7 lines
include/drm/drm_file.h +0 -0

I changed these to:

include/drm/drm_file.h +0 -0

quilt (which I am using) can generate a/ b/ patches instead of linux.orig/ and linux/ patches.

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

This wasn't enough for the second patch, I had to re-do the changes by hand from scratch.

Quoted 7 lines
Quoted 2 lines

I would like more information about this one if it's not too much trouble for you.

IIRC it was the usual git-am error "fatal: sha1 information is lacking or useless". Maybe you wrote the patch for an old tree and drm-misc-next contained changes near the lines you changed? Maybe providing base-commit information in the patch would've helped? I'm not sure.

OK, thanks Simon.

Signature · 1 line
~Randy