Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Date:   Wed, 18 Oct 2023 15:17:10 -0700
From:   Alison Schofield <alison.schofield@intel.com>
To:     Karolina Stolarek <karolina.stolarek@intel.com>
Cc:     Julia Lawall <julia.lawall@inria.fr>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        kenechukwu maduechesi <maduechesik@gmail.com>,
        outreachy@lists.linux.dev, shreeya.patel23498@gmail.com,
        linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] staging: rts5208: Replace delay function.
Message-ID: <ZTBZZvE/oYqCYNPp@aschofie-mobl2>
References: <20231018004300.GA3189@ubuntu>
 <7bc719c4-459f-3d8-7ed-b1e1adf158@inria.fr>
 <1118ec6d-e1e7-79f3-08e4-9a79c996eed1@intel.com>
 <2023101853-axis-stylist-f1b9@gregkh>
 <7dde176b-1059-e9a4-a023-0243cce61d01@intel.com>
 <12b375b1-acd3-476e-17bc-b4db22efba69@inria.fr>
 <cf483cb5-7d94-9514-2213-46778b5ac9f4@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <cf483cb5-7d94-9514-2213-46778b5ac9f4@intel.com>
Precedence: bulk

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
> > > 
>