Re: [PATCH] staging: rts5208: Replace delay function.

[Alison Schofield]

On Wed, Oct 18, 2023 at 12:40:33PM +0200, Karolina Stolarek wrote:
> On 18.10.2023 12:28, Julia Lawall wrote:
> > 
> > 
> > On Wed, 18 Oct 2023, Karolina Stolarek wrote:
> > 
> > > On 18.10.2023 09:45, Greg Kroah-Hartman wrote:
> > > > On Wed, Oct 18, 2023 at 09:32:46AM +0200, Karolina Stolarek wrote:
> > > > > On 18.10.2023 09:03, Julia Lawall wrote:
> > > > > > 
> > > > > > 
> > > > > > On Tue, 17 Oct 2023, kenechukwu maduechesi wrote:
> > > > > > 
> > > > > > > Replace udelay() with usleep_range() for more precise delay handling.
> > > > > > > 
> > > > > > > Reported by checkpatch:
> > > > > > > 
> > > > > > > CHECK: usleep_range is preferred over udelay
> > > > > > 
> > > > > > This message is typically not a good candidate for outreachy patches,
> > > > > > because you need access to the device to be sure that any change is
> > > > > > correct.
> > > > > 
> > > > > Could we add a paragraph on how to pick good checkpatch.pl error to fix to
> > > > > the Outreachyfirstpatch docs? This could go to "Find a driver to clean up"
> > > > > section, for example.
> > > > 
> > > > The ability to find a "good" error changes over time, so this might be
> > > > hard to do.
> > > 
> > > I agree, but we can all agree that experimenting with udelay during Outreachy
> > > is not a good idea, and people should know about it
> > 
> > In general, I think that it is better in the contribution period to do the
> > wrong thing and then learn about why it is wrong, but this case comes up
> > over and over, and it is always not the right thing to do, so I added an
> > appropriate explanation.  Thanks for the suggestion.
> 
> Absolutely. Thanks for the docs update. Still, one thing -- is empty section
> after "Some drivers that are on their way out of the kernel are:"
> intentional?
> 
> All the best,
> Karolina

Perhaps an applicant can expand on that "Find a driver to clean up..."
section with a overview of how to use the Outreachy Mailing list,
or any Mailing list to search for patches that cleaned up up the
checkpatch error/warning/check that they are examining.

Here's the query for the udelay one:
https://lore.kernel.org/outreachy/?q=%22CHECK%3A+usleep_range+is+preferred+over+udelay%22

When submitters include the actual checkpatch string in their commit log 
it very easy to find and reference.

For the first patch tutorial, I'll suggest something as simple as:
1) goto https://lore.kernel.org/outreachy/
2) enter the checkpatch string in the 'search' box
3) boom - go see what others have done with this checkpatch error

Or, if someone wants to get fancy they can add screenshots :)

Note, that we really like to keep the language similar on these
cleanups. Find a few references, and do as they did.

> 
> > 
> > julia
> > 
> > > 
> > > All the best,
> > > Karolina
> > > 
> > > > 
> > > > good luck!
> > > > 
> > > > greg k-h
> > > 
>