[Outreachy Info] Ask for help finding cleanups

[Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

Hi Applicants,

We want to support you finding cleanups. Today I spent some time
looking through staging and am working up a small todo list that
may be useful.

I posted one such cleanup to Menna because I saw them submit a
couple of attempts at a first patches.

I think that Kloudifold, Khadija, and Sumitra are busy iterating on
their first patches. Keep going! Ask for help finding your second
patch if needed.

Anyone else who wants help in finding their first patch, please reach
out. I imagine their are some folks exploring here, that I haven't
met on the list yet. 

Finally, it seems we won't be holding to the traditional 10 cleanup
patch requirement this round! Please continue your efforts and I'll
redirect you towards projects after a 'few' cleanup patches are
accepted into staging.

Thanks,
Alison

Re: [Outreachy Info] Ask for help finding cleanups

[Mark Heim]

On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> Hi Applicants,
> 
> We want to support you finding cleanups. Today I spent some time
> looking through staging and am working up a small todo list that
> may be useful.

I'm interested in doing the required demo for the kernel. Let
me know what I should do next presupposing there is a list of tasks.

> 
> I posted one such cleanup to Menna because I saw them submit a
> couple of attempts at a first patches.
> 
> I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> their first patches. Keep going! Ask for help finding your second
> patch if needed.
> 
> Anyone else who wants help in finding their first patch, please reach
> out. I imagine their are some folks exploring here, that I haven't
> met on the list yet. 

Hello, that's me! I was originally working on the Outreachy LLVM
project but had short term health problems, and that meant I let
that opportunity get away. 

> 
> Finally, it seems we won't be holding to the traditional 10 cleanup
> patch requirement this round! Please continue your efforts and I'll
> redirect you towards projects after a 'few' cleanup patches are
> accepted into staging.
> 

I have some catching up to do. I dug through a little more
than a page of Linux mailing list messages but was able to
glean a bunch of things that were helpful. These are things like
patch creation best practices, posting on code style, joining
a mailing list, and documentation.

Hope to hear from everyone later.

(here's a question: is it best practice to include 100 percent
of the message pre-insertion of comments, or can I delete some
of the original message?)

> Thanks,
> Alison
> 
> 
> 

Re: [Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

On Wed, Mar 15, 2023 at 01:44:10AM -0600, Mark Heim wrote:
> On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > Hi Applicants,
> > 
> > We want to support you finding cleanups. Today I spent some time
> > looking through staging and am working up a small todo list that
> > may be useful.
> 
> I'm interested in doing the required demo for the kernel. Let
> me know what I should do next presupposing there is a list of tasks.



> 
> > 
> > I posted one such cleanup to Menna because I saw them submit a
> > couple of attempts at a first patches.
> > 
> > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > their first patches. Keep going! Ask for help finding your second
> > patch if needed.
> > 
> > Anyone else who wants help in finding their first patch, please reach
> > out. I imagine their are some folks exploring here, that I haven't
> > met on the list yet. 
> 
> Hello, that's me! I was originally working on the Outreachy LLVM
> project but had short term health problems, and that meant I let
> that opportunity get away. 
> 
> > 
> > Finally, it seems we won't be holding to the traditional 10 cleanup
> > patch requirement this round! Please continue your efforts and I'll
> > redirect you towards projects after a 'few' cleanup patches are
> > accepted into staging.
> > 
> 
> I have some catching up to do. I dug through a little more
> than a page of Linux mailing list messages but was able to
> glean a bunch of things that were helpful. These are things like
> patch creation best practices, posting on code style, joining
> a mailing list, and documentation.
> 
> Hope to hear from everyone later.
> 
> (here's a question: is it best practice to include 100 percent
> of the message pre-insertion of comments, or can I delete some
> of the original message?)

To snip or not to snip!  I think not-snipping here was appropriate.

This is the formal starting point:
https://www.outreachy.org/outreachy-may-2023-internship-cohort/communities/linux-kernel/

Each project starts with 'Community-Wide Requirements', so follow that
section. 

Welcome,
Alison

> 
> > Thanks,
> > Alison
> > 
> > 
> > 
> 

Re: [Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

On Wed, Mar 15, 2023 at 11:54:16PM -0600, Mark Heim wrote:
> Hello all,
> 
> I have found a refactoring opportunity that might be a good
> starting point for me, but it is buried in the code.
> 
> It is in the prism2fw.c file under the directory tree
> kernels/staging/drivers/staging. I'm trying to do a procedure
> called extract a method (according to a book I have) that provides
> better modularity for the code and makes further refactorings easier.
> 
> I was a little surprised that the rebasing was going through with updates,
> but I'm probably going to be able to finish this task by tomorrow. I hope
> I get a shot at this one this time.

Sounds interesting Mark!

prism2fw.c is a 'utility for downloading prism2 images moved into kernelspace'
so you'll just be compiling the utility itself, not the PRIMS2_USB
driver. 

At the moment, it doesn't compile, as is, in my environment.
Let me know if you encounter, and have a solution for this:

$ cc prism2fw.c
prism2fw.c:51:10: fatal error: linux/ihex.h: No such file or directory
   51 | #include <linux/ihex.h>
      |          ^~~~~~~~~~~~~~
compilation terminated.

Alison

> 
> Mark
> 
> On Wed, Mar 15, 2023 at 12:12 PM Alison Schofield <
> alison.schofield@intel.com> wrote:
> 
> > On Wed, Mar 15, 2023 at 01:44:10AM -0600, Mark Heim wrote:
> > > On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > > > Hi Applicants,
> > > >
> > > > We want to support you finding cleanups. Today I spent some time
> > > > looking through staging and am working up a small todo list that
> > > > may be useful.
> > >
> > > I'm interested in doing the required demo for the kernel. Let
> > > me know what I should do next presupposing there is a list of tasks.
> >
> >
> >
> > >
> > > >
> > > > I posted one such cleanup to Menna because I saw them submit a
> > > > couple of attempts at a first patches.
> > > >
> > > > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > > > their first patches. Keep going! Ask for help finding your second
> > > > patch if needed.
> > > >
> > > > Anyone else who wants help in finding their first patch, please reach
> > > > out. I imagine their are some folks exploring here, that I haven't
> > > > met on the list yet.
> > >
> > > Hello, that's me! I was originally working on the Outreachy LLVM
> > > project but had short term health problems, and that meant I let
> > > that opportunity get away.
> > >
> > > >
> > > > Finally, it seems we won't be holding to the traditional 10 cleanup
> > > > patch requirement this round! Please continue your efforts and I'll
> > > > redirect you towards projects after a 'few' cleanup patches are
> > > > accepted into staging.
> > > >
> > >
> > > I have some catching up to do. I dug through a little more
> > > than a page of Linux mailing list messages but was able to
> > > glean a bunch of things that were helpful. These are things like
> > > patch creation best practices, posting on code style, joining
> > > a mailing list, and documentation.
> > >
> > > Hope to hear from everyone later.
> > >
> > > (here's a question: is it best practice to include 100 percent
> > > of the message pre-insertion of comments, or can I delete some
> > > of the original message?)
> >
> > To snip or not to snip!  I think not-snipping here was appropriate.
> >
> > This is the formal starting point:
> >
> > https://www.outreachy.org/outreachy-may-2023-internship-cohort/communities/linux-kernel/
> >
> > Each project starts with 'Community-Wide Requirements', so follow that
> > section.
> >
> > Welcome,
> > Alison
> >
> > >
> > > > Thanks,
> > > > Alison
> > > >
> > > >
> > > >
> > >
> >
> >

Re: [Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

+outreachy

On Thu, Mar 16, 2023 at 06:36:18PM -0600, Mark Heim wrote:
> Hello,
> 
> It looks like the two headers at the top of prism2fw.c
> are in the staging/include directory. I didn't notice
> that the makefile for the build does not compile it.
> A proper PATH variable upon compiling should fix
> that issue.

Thanks Mark!
Maybe directions to compile it belong at the top of the file.

> 
> Mark
> 
> On Thu, Mar 16, 2023 at 8:53 AM Alison Schofield <alison.schofield@intel.com>
> wrote:
> 
> > On Wed, Mar 15, 2023 at 11:54:16PM -0600, Mark Heim wrote:
> > > Hello all,
> > >
> > > I have found a refactoring opportunity that might be a good
> > > starting point for me, but it is buried in the code.
> > >
> > > It is in the prism2fw.c file under the directory tree
> > > kernels/staging/drivers/staging. I'm trying to do a procedure
> > > called extract a method (according to a book I have) that provides
> > > better modularity for the code and makes further refactorings easier.
> > >
> > > I was a little surprised that the rebasing was going through with
> > updates,
> > > but I'm probably going to be able to finish this task by tomorrow. I hope
> > > I get a shot at this one this time.
> >
> > Sounds interesting Mark!
> >
> > prism2fw.c is a 'utility for downloading prism2 images moved into
> > kernelspace'
> > so you'll just be compiling the utility itself, not the PRIMS2_USB
> > driver.
> >
> > At the moment, it doesn't compile, as is, in my environment.
> > Let me know if you encounter, and have a solution for this:
> >
> > $ cc prism2fw.c
> > prism2fw.c:51:10: fatal error: linux/ihex.h: No such file or directory
> >    51 | #include <linux/ihex.h>
> >       |          ^~~~~~~~~~~~~~
> > compilation terminated.
> >
> > Alison
> >
> > >
> > > Mark
> > >
> > > On Wed, Mar 15, 2023 at 12:12 PM Alison Schofield <
> > > alison.schofield@intel.com> wrote:
> > >
> > > > On Wed, Mar 15, 2023 at 01:44:10AM -0600, Mark Heim wrote:
> > > > > On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > > > > > Hi Applicants,
> > > > > >
> > > > > > We want to support you finding cleanups. Today I spent some time
> > > > > > looking through staging and am working up a small todo list that
> > > > > > may be useful.
> > > > >
> > > > > I'm interested in doing the required demo for the kernel. Let
> > > > > me know what I should do next presupposing there is a list of tasks.
> > > >
> > > >
> > > >
> > > > >
> > > > > >
> > > > > > I posted one such cleanup to Menna because I saw them submit a
> > > > > > couple of attempts at a first patches.
> > > > > >
> > > > > > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > > > > > their first patches. Keep going! Ask for help finding your second
> > > > > > patch if needed.
> > > > > >
> > > > > > Anyone else who wants help in finding their first patch, please
> > reach
> > > > > > out. I imagine their are some folks exploring here, that I haven't
> > > > > > met on the list yet.
> > > > >
> > > > > Hello, that's me! I was originally working on the Outreachy LLVM
> > > > > project but had short term health problems, and that meant I let
> > > > > that opportunity get away.
> > > > >
> > > > > >
> > > > > > Finally, it seems we won't be holding to the traditional 10 cleanup
> > > > > > patch requirement this round! Please continue your efforts and I'll
> > > > > > redirect you towards projects after a 'few' cleanup patches are
> > > > > > accepted into staging.
> > > > > >
> > > > >
> > > > > I have some catching up to do. I dug through a little more
> > > > > than a page of Linux mailing list messages but was able to
> > > > > glean a bunch of things that were helpful. These are things like
> > > > > patch creation best practices, posting on code style, joining
> > > > > a mailing list, and documentation.
> > > > >
> > > > > Hope to hear from everyone later.
> > > > >
> > > > > (here's a question: is it best practice to include 100 percent
> > > > > of the message pre-insertion of comments, or can I delete some
> > > > > of the original message?)
> > > >
> > > > To snip or not to snip!  I think not-snipping here was appropriate.
> > > >
> > > > This is the formal starting point:
> > > >
> > > >
> > https://www.outreachy.org/outreachy-may-2023-internship-cohort/communities/linux-kernel/
> > > >
> > > > Each project starts with 'Community-Wide Requirements', so follow that
> > > > section.
> > > >
> > > > Welcome,
> > > > Alison
> > > >
> > > > >
> > > > > > Thanks,
> > > > > > Alison
> > > > > >
> > > > > >
> > > > > >
> > > > >
> > > >
> > > >
> >

Re: [Outreachy Info] Ask for help finding cleanups

[Menna Mahmoud]

Hi Alison,

Thanks, appreciate your help.

On ١٥‏/٣‏/٢٠٢٣ ٠١:٤٩, Alison Schofield wrote:
> Hi Applicants,
>
> We want to support you finding cleanups. Today I spent some time
> looking through staging and am working up a small todo list that
> may be useful.
>
> I posted one such cleanup to Menna because I saw them submit a
> couple of attempts at a first patches.

Thanks, but Ira said that Kadija has been working on it, so please if 
you can send another one.

appreciate your support.


Best Regards,

Menna

>
> I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> their first patches. Keep going! Ask for help finding your second
> patch if needed.
>
> Anyone else who wants help in finding their first patch, please reach
> out. I imagine their are some folks exploring here, that I haven't
> met on the list yet.
>
> Finally, it seems we won't be holding to the traditional 10 cleanup
> patch requirement this round! Please continue your efforts and I'll
> redirect you towards projects after a 'few' cleanup patches are
> accepted into staging.
>
> Thanks,
> Alison
>
>
>

Re: [Outreachy Info] Ask for help finding cleanups

[Julia Lawall]

Here is a possible suggestion of something to do.

There is a macro called container_of that extracts a structure that
surrounds another structure (you may find it interesting to look at the
definition of this macro).

In the staging tree, there are some definitions like:

#define to_lm3554(p_sd)	container_of(p_sd, struct lm3554, sd)

These are often in header (.h) files, but you may want to check .c files
too.

It is not great to have such a thing as a macro, because from looking at
the definition one cannot tell what type it applies to.

One can get the same benefit from an efficiency point of view by making an
inline function (concretely, typically a static inline function, because
the definition only needs to be visible in the current file, or in the
case of a header file in the file that includes the header file).

So the idea is to convert these macros into function definitions.

The possible challenge is that a function takes an argument of a specific
type and returns a value of a specific type.  In this case, there is
always the possibility that the macro is being used because the arguemnt
has different types at different call sites.  So you need to check all the
call sites, find the type of the argument, and check that that same type
is used at all call sites.

julia

Re: [Outreachy Info] Ask for help finding cleanups

[Menna Mahmoud]

On ١٥‏/٣‏/٢٠٢٣ ١١:١٩, Julia Lawall wrote:
> Here is a possible suggestion of something to do.
>
> There is a macro called container_of that extracts a structure that
> surrounds another structure (you may find it interesting to look at the
> definition of this macro).
>
> In the staging tree, there are some definitions like:
>
> #define to_lm3554(p_sd)	container_of(p_sd, struct lm3554, sd)
>
> These are often in header (.h) files, but you may want to check .c files
> too.
>
> It is not great to have such a thing as a macro, because from looking at
> the definition one cannot tell what type it applies to.
>
> One can get the same benefit from an efficiency point of view by making an
> inline function (concretely, typically a static inline function, because
> the definition only needs to be visible in the current file, or in the
> case of a header file in the file that includes the header file).
>
> So the idea is to convert these macros into function definitions.
>
> The possible challenge is that a function takes an argument of a specific
> type and returns a value of a specific type.  In this case, there is
> always the possibility that the macro is being used because the arguemnt
> has different types at different call sites.  So you need to check all the
> call sites, find the type of the argument, and check that that same type
> is used at all call sites.
>
> julia
>

Got it, Thanks Julia, I will check this. appreciate your help.


Menna

Re: [Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

On Wed, Mar 15, 2023 at 10:15:45AM +0100, Olofu Ojoachubione wrote:
> Hello Alison,
> Please where can I text you so you could help me out with the kernel
> process so I can start making my contributions.
> 

Hi Olofu,

I'm personally not on any of the Outreachy chat rooms, but you can
try them out:

Join the #outreachy IRC channel on irc.gnome.org, and the
#kernel-outreachy channel on irc.oftc.net.

It looks like you found the mailing list, so scroll back through
that and find the Welcome message of March 7th.

You are welcome to email me, and please 'CC the outreachy list.

Welcome,
Alison


> On Wed, 15 Mar 2023 at 00:49, Alison Schofield <alison.schofield@intel.com>
> wrote:
> 
> > Hi Applicants,
> >
> > We want to support you finding cleanups. Today I spent some time
> > looking through staging and am working up a small todo list that
> > may be useful.
> >
> > I posted one such cleanup to Menna because I saw them submit a
> > couple of attempts at a first patches.
> >
> > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > their first patches. Keep going! Ask for help finding your second
> > patch if needed.
> >
> > Anyone else who wants help in finding their first patch, please reach
> > out. I imagine their are some folks exploring here, that I haven't
> > met on the list yet.
> >
> > Finally, it seems we won't be holding to the traditional 10 cleanup
> > patch requirement this round! Please continue your efforts and I'll
> > redirect you towards projects after a 'few' cleanup patches are
> > accepted into staging.
> >
> > Thanks,
> > Alison
> >
> >
> >
> >

Re: [Outreachy Info] Ask for help finding cleanups

[Sumitra Sharma]

On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> Hi Applicants,
> 
> We want to support you finding cleanups. Today I spent some time
> looking through staging and am working up a small todo list that
> may be useful.
> 
> I posted one such cleanup to Menna because I saw them submit a
> couple of attempts at a first patches.
> 
> I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> their first patches. Keep going! Ask for help finding your second
> patch if needed.
> 

Hi Alison,

My first patch is accepted. I will appreciate if you could help me to find a
second patch.
 
Regards,

Sumitra

> Anyone else who wants help in finding their first patch, please reach
> out. I imagine their are some folks exploring here, that I haven't
> met on the list yet. 
> 
> Finally, it seems we won't be holding to the traditional 10 cleanup
> patch requirement this round! Please continue your efforts and I'll
> redirect you towards projects after a 'few' cleanup patches are
> accepted into staging.
> Thanks,
> Alison
> 
> 
> 

Re: [Outreachy Info] Ask for help finding cleanups

[Alison Schofield]

On Thu, Mar 16, 2023 at 06:16:56AM -0700, Sumitra Sharma wrote:
> On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > Hi Applicants,
> > 
> > We want to support you finding cleanups. Today I spent some time
> > looking through staging and am working up a small todo list that
> > may be useful.
> > 
> > I posted one such cleanup to Menna because I saw them submit a
> > couple of attempts at a first patches.
> > 
> > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > their first patches. Keep going! Ask for help finding your second
> > patch if needed.
> > 
> 
> Hi Alison,
> 
> My first patch is accepted. I will appreciate if you could help me to find a
> second patch.
>  
> Regards,
> 
> Sumitra

Congratulations on getting the patch accepted!
I do see you sent another patch, and GregKH responded that it needs
followup. He sent his automatic, problem with commit message and or
commit log email. Revisit the docs he suggested and the first patch
tutorial and see if you can come up with a rev 2 where the commit
message 'says what you did' and the commit log 'says why you did it'.

> 
> > Anyone else who wants help in finding their first patch, please reach
> > out. I imagine their are some folks exploring here, that I haven't
> > met on the list yet. 
> > 
> > Finally, it seems we won't be holding to the traditional 10 cleanup
> > patch requirement this round! Please continue your efforts and I'll
> > redirect you towards projects after a 'few' cleanup patches are
> > accepted into staging.
> > Thanks,
> > Alison
> > 
> > 
> > 
> 

Re: [Outreachy Info] Ask for help finding cleanups

[Sumitra Sharma]

On Thu, Mar 16, 2023 at 08:07:16AM -0700, Alison Schofield wrote:
> On Thu, Mar 16, 2023 at 06:16:56AM -0700, Sumitra Sharma wrote:
> > On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > > Hi Applicants,
> > > 
> > > We want to support you finding cleanups. Today I spent some time
> > > looking through staging and am working up a small todo list that
> > > may be useful.
> > > 
> > > I posted one such cleanup to Menna because I saw them submit a
> > > couple of attempts at a first patches.
> > > 
> > > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > > their first patches. Keep going! Ask for help finding your second
> > > patch if needed.
> > > 
> > 
> > Hi Alison,
> > 
> > My first patch is accepted. I will appreciate if you could help me to find a
> > second patch.
> >  
> > Regards,
> > 
> > Sumitra
> 
> Congratulations on getting the patch accepted!
> I do see you sent another patch, and GregKH responded that it needs
> followup. He sent his automatic, problem with commit message and or
> commit log email. Revisit the docs he suggested and the first patch
> tutorial and see if you can come up with a rev 2 where the commit
> message 'says what you did' and the commit log 'says why you did it'.
> 

Hi Alison,

I will work this way, Thank you for your guidance.

Regards,

Sumitra

Re: [Outreachy Info] Ask for help finding cleanups

[Fabio M. De Francesco]

On giovedì 16 marzo 2023 14:16:56 CET Sumitra Sharma wrote:
> On Tue, Mar 14, 2023 at 04:49:20PM -0700, Alison Schofield wrote:
> > Hi Applicants,
> > 
> > We want to support you finding cleanups. Today I spent some time
> > looking through staging and am working up a small todo list that
> > may be useful.
> > 
> > I posted one such cleanup to Menna because I saw them submit a
> > couple of attempts at a first patches.
> > 
> > I think that Kloudifold, Khadija, and Sumitra are busy iterating on
> > their first patches. Keep going! Ask for help finding your second
> > patch if needed.
> 
> Hi Alison,
> 
> My first patch is accepted. I will appreciate if you could help me to find a
> second patch.

I don't want to answer for Alison, however I would like to point out that in 
this same thread there are several suggestions, both from Alison and Julia, on 
how to find tasks in "driver/staging".

Scroll through the thread again and see if it helps you find more tasks. 
Alison's first post explains an effective way to find something in drivers/
staging

Thank you,

Fabio

PS: I think applicants shouldn't overlook Julia's post about certain macros 
evaluating in container_of(). As Julia suggested, you can work on converting 
these macros into function definitions. 

Furthermore, this kind of work would help to understand the working and 
implementation details of container_of(), itself a macro used a lot in the 
drivers and core subsystems of the entire Kernel.

Isn't anyone interested in this kind of tasks? Please have a look at https://
lore.kernel.org/outreachy/124d2ef9-6f1d-2652-c88d-161f1bc06443@inria.fr/

> Regards,
> 
> Sumitra
> 
> > Anyone else who wants help in finding their first patch, please reach
> > out. I imagine their are some folks exploring here, that I haven't
> > met on the list yet.
> > 
> > Finally, it seems we won't be holding to the traditional 10 cleanup
> > patch requirement this round! Please continue your efforts and I'll
> > redirect you towards projects after a 'few' cleanup patches are
> > accepted into staging.
> > Thanks,
> > Alison