Help maintain the First Patch Tutorial

Help maintain the First Patch Tutorial

[Alison Schofield]

Hi Applicants,

Please help maintain the First Patch Tutorial.

If you see an opportunity for improvement please post your
suggested update to this list, where you'll get someone else
to ACK your change, and then you can change it in the Wiki.

You'll need to create an login on kernelnewbies.org.
https://kernelnewbies.org/

When you actually have a change to place in the WIKI, just
ask me, or any other current 'Editor' for edit privileges.

And, be sure to note this as a contribution in your application.
It won't count towards your 10 patches, but it is highly valued!!!

Thanks for helping,
Alison

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

Hi Alison,

I updated the `get_maintainer.pl` code section and split it up a bit,
hope it's fine. Additionally, I decided to extract the note on
`vc04_services` so it's more visible and add a comment on including the
outreachy list (as a reminder).

One thing - should I use double-spaces while editing this wiki? I see
they're used there, I added some in but I wouldn't be surprised if I
missed some.

Please let me know what do you think about these changes.


Thanks,
Karolina

----------------------------------------------------------------------

<<Anchor(submit_a_patch)>>
= Submit a patch =

The first step to sending a patch is to figure out who to send it to. 
For this, you need to find the maintainer of the code you're patching,
and Cc the correct mailing list.  If you simply send it off to LKML, it
will get ignored.  The perl script in the kernel source directory
``scripts/get_maintainer.pl`` will either take a git commit or a file,
and tell you who to send your patch to:

{{{
$ git show --pretty=oneline --abbrev-commit HEAD
a490e2e84eda staging: vt6655: Rename byPreambleType field
diff --git a/drivers/staging/vt6655/baseband.c
b/drivers/staging/vt6655/baseband.c
index 0bae35af6e0f..5efca92f1f18 100644
--- a/drivers/staging/vt6655/baseband.c
+++ b/drivers/staging/vt6655/baseband.c
@@ -1764,7 +1764,7 @@ void vnt_get_phy_field(struct vnt_private *priv,
u32 frame_length,
        u32 count = 0;
        u32 tmp;
        int ext_bit;
-       u8 preamble_type = priv->byPreambleType;
+       u8 preamble_type = priv->preamble_type;
 
        bit_count = frame_length * 8;
        ext_bit = false;

$ git show HEAD | perl scripts/get_maintainer.pl --separator , --
nokeywords --nogit --nogit-fallback --norolestats
Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
<gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
}}}

It is also possible to get a list of maintainers for a particular file
(`-f` option):

{{{
$ perl scripts/get_maintainer.pl --separator , --nokeywords --nogit --
nogit-fallback --norolestats -f drivers/staging/vt6655/baseband.c 
Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
<gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
}}}

The many arguments to get_maintainer.pl cause the output to be in the
form of a comma-separated list and cause only the actual maintainers of
the affected files to be included. However, for IIO drivers, please
also include linux-iio@vger.kernel.org.  For Outreachy patches,
remember to include the outreachy mailing list in your `To:` field as
well.

'''Important:''' The maintainers of staging/vc04_services would prefer
'''not''' to be CCd on Outreachy patches. Please CC Greg explicitly on
these patches: Greg KH <gregkh@linuxfoundation.org>.

The second step to submitting a patch is to create and send a patch as
an email.  You cannot send patches as attachments to the mailing list.
Instead, you will have to craft a special email, and send the patch
inline.

There are two ways to send a patch.  Either way is correct, and we
suggest you get comfortable with sending patches both ways.  We suggest
sending your first patch to yourself, in order to make sure it works.

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Julia Lawall]

On Mon, 18 Oct 2021, Karolina Drobnik wrote:

> Hi Alison,
>
> I updated the `get_maintainer.pl` code section and split it up a bit,
> hope it's fine. Additionally, I decided to extract the note on
> `vc04_services` so it's more visible and add a comment on including the
> outreachy list (as a reminder).
>
> One thing - should I use double-spaces while editing this wiki? I see
> they're used there, I added some in but I wouldn't be surprised if I
> missed some.
>
> Please let me know what do you think about these changes.
>
> Thanks,
> Karolina
>
> ----------------------------------------------------------------------
>
> <<Anchor(submit_a_patch)>>
> = Submit a patch =
>
> The first step to sending a patch is to figure out who to send it to.
> For this, you need to find the maintainer of the code you're patching,
> and Cc the correct mailing list.  If you simply send it off to LKML, it
> will get ignored.  The perl script in the kernel source directory
> ``scripts/get_maintainer.pl`` will either take a git commit or a file,
> and tell you who to send your patch to:
>
> {{{
> $ git show --pretty=oneline --abbrev-commit HEAD
> a490e2e84eda staging: vt6655: Rename byPreambleType field
> diff --git a/drivers/staging/vt6655/baseband.c
> b/drivers/staging/vt6655/baseband.c
> index 0bae35af6e0f..5efca92f1f18 100644
> --- a/drivers/staging/vt6655/baseband.c
> +++ b/drivers/staging/vt6655/baseband.c
> @@ -1764,7 +1764,7 @@ void vnt_get_phy_field(struct vnt_private *priv,
> u32 frame_length,
>         u32 count = 0;
>         u32 tmp;
>         int ext_bit;
> -       u8 preamble_type = priv->byPreambleType;
> +       u8 preamble_type = priv->preamble_type;
>
>         bit_count = frame_length * 8;
>         ext_bit = false;
>
> $ git show HEAD | perl scripts/get_maintainer.pl --separator , --
> nokeywords --nogit --nogit-fallback --norolestats
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
>
> It is also possible to get a list of maintainers for a particular file
> (`-f` option):
>
> {{{
> $ perl scripts/get_maintainer.pl --separator , --nokeywords --nogit --
> nogit-fallback --norolestats -f drivers/staging/vt6655/baseband.c
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
>
> The many arguments to get_maintainer.pl cause the output to be in the
> form of a comma-separated list and cause only the actual maintainers of
> the affected files to be included. However, for IIO drivers, please
> also include linux-iio@vger.kernel.org.

I wonder if this sentence is still needed, if we are dropping the
suggestion to use the --nol argument.

> For Outreachy patches,
> remember to include the outreachy mailing list in your `To:` field as
> well.
>
> '''Important:''' The maintainers of staging/vc04_services would prefer
> '''not''' to be CCd on Outreachy patches. Please CC Greg explicitly on
> these patches: Greg KH <gregkh@linuxfoundation.org>.
>
> The second step to submitting a patch is to create and send a patch as
> an email.  You cannot send patches as attachments to the mailing list.

This would be better as "You cannot send a patch as an attachment..."

thanks,
julia


> Instead, you will have to craft a special email, and send the patch
> inline.
>
> There are two ways to send a patch.  Either way is correct, and we
> suggest you get comfortable with sending patches both ways.  We suggest
> sending your first patch to yourself, in order to make sure it works.
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/c924b4477fa4067b040e9a0d72af3d8eeb882a98.camel%40gmail.com.
>

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

Hi Julia,

Thanks for taking a look at my changes. I'll update the section
accordingly after getting more feedback, hope it's fine.

On Mon, 2021-10-18 at 12:12 +0200, Julia Lawall wrote:
> > The many arguments to get_maintainer.pl cause the output to be in
> > the form of a comma-separated list and cause only the actual
> > maintainers of the affected files to be included. However, for IIO
> > drivers, please also include linux-iio@vger.kernel.org.
>
> I wonder if this sentence is still needed, if we are dropping the
> suggestion to use the --nol argument.

I'd like to still explain what the output would be like. The "actual
maintainers" can also refer to `--nogit-faillback` option that excludes
committers/git information. Can change it to something like "relevant
lists and the actual maintainers..". What do you think?

> > The second step to submitting a patch is to create and send a patch
> > as an email. You cannot send patches as attachments to the mailing
> > list.
>
> This would be better as "You cannot send a patch as an attachment..."

Can correct this, thanks.


Karolina

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Julia Lawall]

On Mon, 18 Oct 2021, Karolina Drobnik wrote:

> Hi Julia,
>
> Thanks for taking a look at my changes. I'll update the section
> accordingly after getting more feedback, hope it's fine.
>
> On Mon, 2021-10-18 at 12:12 +0200, Julia Lawall wrote:
> > > The many arguments to get_maintainer.pl cause the output to be in
> > > the form of a comma-separated list and cause only the actual
> > > maintainers of the affected files to be included. However, for IIO
> > > drivers, please also include linux-iio@vger.kernel.org.
> >
> > I wonder if this sentence is still needed, if we are dropping the
> > suggestion to use the --nol argument.
>
> I'd like to still explain what the output would be like. The "actual
> maintainers" can also refer to `--nogit-faillback` option that excludes
> committers/git information. Can change it to something like "relevant
> lists and the actual maintainers..". What do you think?

Sorry to be unclear.  I was only thinking that the sentence about the IIO
drivers is no longer needed.

julia

>
> > > The second step to submitting a patch is to create and send a patch
> > > as an email. You cannot send patches as attachments to the mailing
> > > list.
> >
> > This would be better as "You cannot send a patch as an attachment..."
>
> Can correct this, thanks.
>
>
> Karolina
>
>
>
>

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Alison Schofield]

On Mon, Oct 18, 2021 at 10:59:42AM +0100, Karolina Drobnik wrote:
> Hi Alison,
> 
> I updated the `get_maintainer.pl` code section and split it up a bit,
> hope it's fine. Additionally, I decided to extract the note on
> `vc04_services` so it's more visible and add a comment on including the
> outreachy list (as a reminder).
> 
> One thing - should I use double-spaces while editing this wiki? I see
> they're used there, I added some in but I wouldn't be surprised if I
> missed some.

Is that the double spaces between sentences you are referring too?
HA HA - that shows that this writing is dated, because double space
between sentences, use to be the standard, but is not anymore ;)

As you change things, certainly get rid of those.

> 
> Please let me know what do you think about these changes.
> 
> 
> Thanks,
> Karolina
> 
> ----------------------------------------------------------------------
> 
> <<Anchor(submit_a_patch)>>
> = Submit a patch =
> 
> The first step to sending a patch is to figure out who to send it to. 
> For this, you need to find the maintainer of the code you're patching,
> and Cc the correct mailing list.  If you simply send it off to LKML, it
> will get ignored. 

Perhaps explain what LKML is, include it's full address.


> The perl script in the kernel source directory
> ``scripts/get_maintainer.pl`` will either take a git commit or a file,
> and tell you who to send your patch to:
> 
> {{{
> $ git show --pretty=oneline --abbrev-commit HEAD
> a490e2e84eda staging: vt6655: Rename byPreambleType field
> diff --git a/drivers/staging/vt6655/baseband.c
> b/drivers/staging/vt6655/baseband.c
> index 0bae35af6e0f..5efca92f1f18 100644
> --- a/drivers/staging/vt6655/baseband.c
> +++ b/drivers/staging/vt6655/baseband.c
> @@ -1764,7 +1764,7 @@ void vnt_get_phy_field(struct vnt_private *priv,
> u32 frame_length,
>         u32 count = 0;
>         u32 tmp;
>         int ext_bit;
> -       u8 preamble_type = priv->byPreambleType;
> +       u8 preamble_type = priv->preamble_type;
>  
>         bit_count = frame_length * 8;
>         ext_bit = false;
> 
> $ git show HEAD | perl scripts/get_maintainer.pl --separator , --
> nokeywords --nogit --nogit-fallback --norolestats
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
> 
> It is also possible to get a list of maintainers for a particular file
> (`-f` option):
> 
> {{{
> $ perl scripts/get_maintainer.pl --separator , --nokeywords --nogit --
> nogit-fallback --norolestats -f drivers/staging/vt6655/baseband.c 
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
> 
> The many arguments to get_maintainer.pl cause the output to be in the
> form of a comma-separated list and cause only the actual maintainers of
> the affected files to be included. However, for IIO drivers, please
> also include linux-iio@vger.kernel.org.  For Outreachy patches,
> remember to include the outreachy mailing list in your `To:` field as
> well.
> 
> '''Important:''' The maintainers of staging/vc04_services would prefer

I think I'm going to pounce on the word 'prefer' and say not to include
this comment. I don't get the inconvenience of Outreachy patches for
2 contribution periods (2 months) per year, to warrant a special case,
when a mail filter could achieve same result.

FYI: Outreachy use to not send patches to maintainers during Outreachy,
but changed that policy after maintainers asked for visibility into
all patches, even though it was GregKH that was the one applying them.

> '''not''' to be CCd on Outreachy patches. Please CC Greg explicitly on
> these patches: Greg KH <gregkh@linuxfoundation.org>.

wrt GregKH - 
If the code is in drivers/staging, I believe gregkh automatically
sees all patches because the patches go to linux-staging list.
Is there really a need to do special handling with GregKH?

> 
> The second step to submitting a patch is to create and send a patch as
> an email.  You cannot send patches as attachments to the mailing list.
> Instead, you will have to craft a special email, and send the patch
> inline.
> 
> There are two ways to send a patch.  Either way is correct, and we
> suggest you get comfortable with sending patches both ways.  We suggest
> sending your first patch to yourself, in order to make sure it works.
> 



> -- 
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/c924b4477fa4067b040e9a0d72af3d8eeb882a98.camel%40gmail.com.

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Greg KH]

On Mon, Oct 18, 2021 at 10:54:20AM -0700, Alison Schofield wrote:
> On Mon, Oct 18, 2021 at 10:59:42AM +0100, Karolina Drobnik wrote:
> > Hi Alison,
> > 
> > I updated the `get_maintainer.pl` code section and split it up a bit,
> > hope it's fine. Additionally, I decided to extract the note on
> > `vc04_services` so it's more visible and add a comment on including the
> > outreachy list (as a reminder).
> > 
> > One thing - should I use double-spaces while editing this wiki? I see
> > they're used there, I added some in but I wouldn't be surprised if I
> > missed some.
> 
> Is that the double spaces between sentences you are referring too?
> HA HA - that shows that this writing is dated, because double space
> between sentences, use to be the standard, but is not anymore ;)

It is still the standard for plain-text email where your email client
shows text in fixed-width fonts.  Just like the old typewriters where
this style was created for.

> > '''not''' to be CCd on Outreachy patches. Please CC Greg explicitly on
> > these patches: Greg KH <gregkh@linuxfoundation.org>.
> 
> wrt GregKH - 
> If the code is in drivers/staging, I believe gregkh automatically
> sees all patches because the patches go to linux-staging list.
> Is there really a need to do special handling with GregKH?

You need to ALWAYS cc: the maintainers of the subsystem for a patch, I
am not being treated differently here at all.

To not do so is to risk your patches being lost in the noise.

thanks,

greg k-h

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

Hi,

Thank you very much for your comments. You can find an updated version
of this section below.


Thanks,
Karolina

------------------------------------------------------------

<<Anchor(submit_a_patch)>>
= Submit a patch =

The first step to sending a patch is to figure out who to send it to.
For this, you need to find the maintainer of the code you're patching,
and Cc the correct mailing list. If you simply send it off to
linux-kernel@vger.kernel.org, it will get ignored. The perl script in
the kernel source directory ``scripts/get_maintainer.pl`` will either
take a git commit or a file, and tell you who to send your patch to:

{{{
$ git show --pretty=oneline --abbrev-commit HEAD
a490e2e84eda staging: vt6655: Rename byPreambleType field
diff --git a/drivers/staging/vt6655/baseband.c
b/drivers/staging/vt6655/baseband.c
index 0bae35af6e0f..5efca92f1f18 100644
--- a/drivers/staging/vt6655/baseband.c
+++ b/drivers/staging/vt6655/baseband.c
@@ -1764,7 +1764,7 @@ void vnt_get_phy_field(struct vnt_private *priv,
u32 frame_length,
        u32 count = 0;
        u32 tmp;
        int ext_bit;
-       u8 preamble_type = priv->byPreambleType;
+       u8 preamble_type = priv->preamble_type;
 
        bit_count = frame_length * 8;
        ext_bit = false;

$ git show HEAD | perl scripts/get_maintainer.pl --separator , --
nokeywords --nogit --nogit-fallback --norolestats
Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
<gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
}}}

To get a list of maintainers for a particular file, use `-f` option:

{{{
$ perl scripts/get_maintainer.pl --separator , --nokeywords --nogit --
nogit-fallback --norolestats -f drivers/staging/vt6655/baseband.c 
Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
<gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
}}}

The many arguments to get_maintainer.pl cause the output to be in the
form of a comma-separated list and cause only the actual maintainers of
the affected files and relevant mailing lists to be included. For
Outreachy patches, remember to include the outreachy mailing list in
your `To:` field as well.

The second step to submitting a patch is to create and send a patch as
an email. You cannot send patches as attachments to the mailing list.
Instead, you will have to craft a special email, and send the patch
inline.

There are two ways to send a patch. Either way is correct, and we
suggest you get comfortable with sending patches both ways. We suggest
sending your first patch to yourself, in order to make sure it works.

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Julia Lawall]

On Tue, 19 Oct 2021, Karolina Drobnik wrote:

> Hi,
>
> Thank you very much for your comments. You can find an updated version
> of this section below.


OK for me.  Thanks!

julia

>
>
> Thanks,
> Karolina
>
> ------------------------------------------------------------
>
> <<Anchor(submit_a_patch)>>
> = Submit a patch =
>
> The first step to sending a patch is to figure out who to send it to.
> For this, you need to find the maintainer of the code you're patching,
> and Cc the correct mailing list. If you simply send it off to
> linux-kernel@vger.kernel.org, it will get ignored. The perl script in
> the kernel source directory ``scripts/get_maintainer.pl`` will either
> take a git commit or a file, and tell you who to send your patch to:
>
> {{{
> $ git show --pretty=oneline --abbrev-commit HEAD
> a490e2e84eda staging: vt6655: Rename byPreambleType field
> diff --git a/drivers/staging/vt6655/baseband.c
> b/drivers/staging/vt6655/baseband.c
> index 0bae35af6e0f..5efca92f1f18 100644
> --- a/drivers/staging/vt6655/baseband.c
> +++ b/drivers/staging/vt6655/baseband.c
> @@ -1764,7 +1764,7 @@ void vnt_get_phy_field(struct vnt_private *priv,
> u32 frame_length,
>         u32 count = 0;
>         u32 tmp;
>         int ext_bit;
> -       u8 preamble_type = priv->byPreambleType;
> +       u8 preamble_type = priv->preamble_type;
>
>         bit_count = frame_length * 8;
>         ext_bit = false;
>
> $ git show HEAD | perl scripts/get_maintainer.pl --separator , --
> nokeywords --nogit --nogit-fallback --norolestats
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
>
> To get a list of maintainers for a particular file, use `-f` option:
>
> {{{
> $ perl scripts/get_maintainer.pl --separator , --nokeywords --nogit --
> nogit-fallback --norolestats -f drivers/staging/vt6655/baseband.c
> Forest Bond <forest@alittletooquiet.net>,Greg Kroah-Hartman
> <gregkh@linuxfoundation.org>,linux-staging@lists.linux.dev,linux-kernel@vger.kernel.org
> }}}
>
> The many arguments to get_maintainer.pl cause the output to be in the
> form of a comma-separated list and cause only the actual maintainers of
> the affected files and relevant mailing lists to be included. For
> Outreachy patches, remember to include the outreachy mailing list in
> your `To:` field as well.
>
> The second step to submitting a patch is to create and send a patch as
> an email. You cannot send patches as attachments to the mailing list.
> Instead, you will have to craft a special email, and send the patch
> inline.
>
> There are two ways to send a patch. Either way is correct, and we
> suggest you get comfortable with sending patches both ways. We suggest
> sending your first patch to yourself, in order to make sure it works.
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/11393669909cdb43a5f0ca99eace0451bca45d30.camel%40gmail.com.
>

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Alison Schofield]

On Tue, Oct 19, 2021 at 08:19:52AM +0200, Greg KH wrote:
> On Mon, Oct 18, 2021 at 10:54:20AM -0700, Alison Schofield wrote:
> > On Mon, Oct 18, 2021 at 10:59:42AM +0100, Karolina Drobnik wrote:
> > > Hi Alison,
> > > 
> > > I updated the `get_maintainer.pl` code section and split it up a bit,
> > > hope it's fine. Additionally, I decided to extract the note on
> > > `vc04_services` so it's more visible and add a comment on including the
> > > outreachy list (as a reminder).
> > > 
> > > One thing - should I use double-spaces while editing this wiki? I see
> > > they're used there, I added some in but I wouldn't be surprised if I
> > > missed some.
> > 
> > Is that the double spaces between sentences you are referring too?
> > HA HA - that shows that this writing is dated, because double space
> > between sentences, use to be the standard, but is not anymore ;)
> 
> It is still the standard for plain-text email where your email client
> shows text in fixed-width fonts.  Just like the old typewriters where
> this style was created for.
> 

Greg -

I understand the background.  I had not thought of it in terms of plain
test email, and by extension, patch logs and cover letters.  Is that a
guideline or rule for Linux Patches, or are am I just going down a rat
hole now?

Alison

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Greg KH]

On Tue, Oct 19, 2021 at 08:36:01AM -0700, Alison Schofield wrote:
> On Tue, Oct 19, 2021 at 08:19:52AM +0200, Greg KH wrote:
> > On Mon, Oct 18, 2021 at 10:54:20AM -0700, Alison Schofield wrote:
> > > On Mon, Oct 18, 2021 at 10:59:42AM +0100, Karolina Drobnik wrote:
> > > > Hi Alison,
> > > > 
> > > > I updated the `get_maintainer.pl` code section and split it up a bit,
> > > > hope it's fine. Additionally, I decided to extract the note on
> > > > `vc04_services` so it's more visible and add a comment on including the
> > > > outreachy list (as a reminder).
> > > > 
> > > > One thing - should I use double-spaces while editing this wiki? I see
> > > > they're used there, I added some in but I wouldn't be surprised if I
> > > > missed some.
> > > 
> > > Is that the double spaces between sentences you are referring too?
> > > HA HA - that shows that this writing is dated, because double space
> > > between sentences, use to be the standard, but is not anymore ;)
> > 
> > It is still the standard for plain-text email where your email client
> > shows text in fixed-width fonts.  Just like the old typewriters where
> > this style was created for.
> > 
> 
> Greg -
> 
> I understand the background.  I had not thought of it in terms of plain
> test email, and by extension, patch logs and cover letters.  Is that a
> guideline or rule for Linux Patches, or are am I just going down a rat
> hole now?

It's a good thing to do for changelog text and emails as they are almost
always read with fixed-width fonts.

But it's not a hard and fast rule, I wouldn't worry too much about it,
there are way too many "real" things to be concerned about when writing
a changelog text.

thanks,

greg k-h

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

Hi Alison,

What do you think about my changes? Can I (or you, if you prefer this
way) update this wiki section?


Thanks,
Karolina

On Tue, 2021-10-19 at 11:04 +0200, Julia Lawall wrote:
> 
> 
> On Tue, 19 Oct 2021, Karolina Drobnik wrote:
> 
> > Hi,
> > 
> > Thank you very much for your comments. You can find an updated
> > version
> > of this section below.
> 
> 
> OK for me.  Thanks!
> 
> julia

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Alison Schofield]

On Wed, Oct 20, 2021 at 02:00:12PM +0100, Karolina Drobnik wrote:
> Hi Alison,
> 
> What do you think about my changes? Can I (or you, if you prefer this
> way) update this wiki section?

The info is improved. Add it.
Thanks!
Alison

> 
> 
> Thanks,
> Karolina
> 
> On Tue, 2021-10-19 at 11:04 +0200, Julia Lawall wrote:
> > 
> > 
> > On Tue, 19 Oct 2021, Karolina Drobnik wrote:
> > 
> > > Hi,
> > > 
> > > Thank you very much for your comments. You can find an updated
> > > version
> > > of this section below.
> > 
> > 
> > OK for me.  Thanks!
> > 
> > julia
> 
> 

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

Hi,

I noticed that the information in the "sending patchsets" section is
slightly outdated. I updated the `git format-patch` listing and added
information on how to actually send the patches.

What do you think about this draft?


Thanks,
Karolina

---------------------------------------------------------------------

<<Anchor(git_format_patch_patchset)>>
== Using git format-patch to send patchsets ==

First, use {{{`git log --pretty=oneline --abbrev-commit`}}} to figure
out the first commit ID you want to send. For example, say that my tree
had this git log history:

{{{
b7ca36a Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS
bf6adaf Docs: Add a tips section to REPORTING-BUGS.
bc6bed4 Docs: Expectations for bug reporters and maintainers
2c97a63 Docs: Add info on supported kernels to REPORTING-BUGS.
7883a25 Docs: Add "Gather info" section to REPORTING-BUGS.
d60418b Docs: Step-by-step directions for reporting bugs.
3b12c21 Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
bb33db7 Merge branches 'timers-urgent-for-linus', 'irq-urgent-for-
linus' and 'core-urgent-for-linus' of
git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
41ef2d5 Linux 3.9-rc7
}}}

The first commit I want to send as part of the patchset has commit ID
3b12c21. The last patch I want to send has commit ID b7ca36a. 
So, I want to pass the commit range {{{3b12c21^..b7ca36a}}} to {{{git
format-patch}}}. (Remember, the {{{git format-patch}}} range starting
commit must be the commit ''before'' the first commit you want to send,
so we use the '^' to specify the patch before commit 3b12c21). The
command will look something like this:

{{{
git format-patch -o /tmp/ --cover-letter -n --thread=shallow
3b12c21^..b7ca36a
}}}

Again, the -o flag specifies where to put the email files. The -n flag
says to add numbering to each patch (e.g. [PATCH 2/5]). The `--
thread=shallow` flag specifies that all patches will be In-Reply-To
your cover letter.

That will output files into /tmp:
{{{
/tmp/0000-cover-letter.patch
/tmp/0001-Trivial-docs-Remove-six-space-indentation-in-REPORTI.patch
/tmp/0002-Docs-Step-by-step-directions-for-reporting-bugs.patch
/tmp/0003-Docs-Add-Gather-info-section-to-REPORTING-BUGS.patch
/tmp/0004-Docs-Add-info-on-supported-kernels-to-REPORTING-BUGS.patch
/tmp/0005-Docs-Expectations-for-bug-reporters-and-maintainers.patch
/tmp/0006-Docs-Add-a-tips-section-to-REPORTING-BUGS.patch
/tmp/0007-Docs-Move-ref-to-Frohwalt-Egerer-to-end-of-REPORTING.patch
}}}

To send them as a patchset, you need to provide a path that matches all
of these files. In this case, the `git send-email` command would look
like this:

{{{
git send-email --to <outreachy mailing list if required> --cc
<addresses from get_maintainer.pl output> /tmp/*
}}}

If you would like to test your patchset emails before sending them, you
can add `--dry-run` option that will execute the command without
sending the actual emails.

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Alison Schofield]

On Mon, Oct 25, 2021 at 12:44:28PM +0100, Karolina Drobnik wrote:
> Hi,
> 
> I noticed that the information in the "sending patchsets" section is
> slightly outdated.�I updated the `git format-patch` listing and added
> information on how to actually send the patches.
> 
> What do you think about this draft?

Thanks for the update.
It seems that the original was lacking the fill in the cover letter
step...at least in this section. Going directly from format-patch to
send-email on a patchset would send an empty cover letter.
See if you can fix that up.
Thanks!

> 
> 
> Thanks,
> Karolina
> 
> ---------------------------------------------------------------------
> 
> <<Anchor(git_format_patch_patchset)>>
> == Using git format-patch to send patchsets ==
> 
> First, use {{{`git log --pretty=oneline --abbrev-commit`}}} to figure
> out the first commit ID you want to send. For example, say that my tree
> had this git log history:
> 
> {{{
> b7ca36a Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS
> bf6adaf Docs: Add a tips section to REPORTING-BUGS.
> bc6bed4 Docs: Expectations for bug reporters and maintainers
> 2c97a63 Docs: Add info on supported kernels to REPORTING-BUGS.
> 7883a25 Docs: Add "Gather info" section to REPORTING-BUGS.
> d60418b Docs: Step-by-step directions for reporting bugs.
> 3b12c21 Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
> bb33db7 Merge branches 'timers-urgent-for-linus', 'irq-urgent-for-
> linus' and 'core-urgent-for-linus' of
> git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
> 41ef2d5 Linux 3.9-rc7
> }}}
> 
> The first commit I want to send as part of the patchset has commit ID
> 3b12c21. The last patch I want to send has commit ID b7ca36a. 
> So, I want to pass the commit range {{{3b12c21^..b7ca36a}}} to {{{git
> format-patch}}}. (Remember, the {{{git format-patch}}} range starting
> commit must be the commit ''before'' the first commit you want to send,
> so we use the '^' to specify the patch before commit 3b12c21). The
> command will look something like this:
> 
> {{{
> git format-patch -o /tmp/ --cover-letter -n --thread=shallow
> 3b12c21^..b7ca36a
> }}}
> 
> Again, the -o flag specifies where to put the email files. The -n flag
> says to add numbering to each patch (e.g. [PATCH 2/5]). The `--
> thread=shallow` flag specifies that all patches will be In-Reply-To
> your cover letter.
> 
> That will output files into /tmp:
> {{{
> /tmp/0000-cover-letter.patch
> /tmp/0001-Trivial-docs-Remove-six-space-indentation-in-REPORTI.patch
> /tmp/0002-Docs-Step-by-step-directions-for-reporting-bugs.patch
> /tmp/0003-Docs-Add-Gather-info-section-to-REPORTING-BUGS.patch
> /tmp/0004-Docs-Add-info-on-supported-kernels-to-REPORTING-BUGS.patch
> /tmp/0005-Docs-Expectations-for-bug-reporters-and-maintainers.patch
> /tmp/0006-Docs-Add-a-tips-section-to-REPORTING-BUGS.patch
> /tmp/0007-Docs-Move-ref-to-Frohwalt-Egerer-to-end-of-REPORTING.patch
> }}}
> 
> To send them as a patchset, you need to provide a path that matches all
> of these files. In this case, the `git send-email` command would look
> like this:
> 
> {{{
> git send-email --to <outreachy mailing list if required> --cc
> <addresses from get_maintainer.pl output> /tmp/*
> }}}
> 
> If you would like to test your patchset emails before sending them, you
> can add `--dry-run` option that will execute the command without
> sending the actual emails.
> 
> 

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

On Mon, 2021-10-25 at 09:30 -0700, Alison Schofield wrote:
> Thanks for the update.
> It seems that the original was lacking the fill in the cover letter
> step...at least in this section. Going directly from format-patch to
> send-email on a patchset would send an empty cover letter.

That's a good call. I'll address it and send an updated version
tomorrow.


Thanks,
Karolina

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Karolina Drobnik]

On Mon, 2021-10-25 at 09:30 -0700, Alison Schofield wrote:
> Thanks for the update.
> It seems that the original was lacking the fill in the cover letter
> step...at least in this section. Going directly from format-patch >
> to send-email on a patchset would send an empty cover letter.
> See if you can fix that up.
> Thanks!

Hi Alison,

I added a description on the cover letter file. Could you take a look
and see if it looks alright?


Thanks,
Karolina

--------------------------------------------------------------------

<<Anchor(git_format_patch_patchset)>>
== Using git format-patch to send patchsets ==

First, use {{{`git log --pretty=oneline --abbrev-commit`}}} to figure
out the first commit ID you want to send. For example, say that my tree
had this git log history:

{{{
b7ca36a Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS
bf6adaf Docs: Add a tips section to REPORTING-BUGS.
bc6bed4 Docs: Expectations for bug reporters and maintainers
2c97a63 Docs: Add info on supported kernels to REPORTING-BUGS.
7883a25 Docs: Add "Gather info" section to REPORTING-BUGS.
d60418b Docs: Step-by-step directions for reporting bugs.
3b12c21 Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
bb33db7 Merge branches 'timers-urgent-for-linus', 'irq-urgent-for-
linus' and 'core-urgent-for-linus' of
git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
41ef2d5 Linux 3.9-rc7
}}}

The first commit I want to send as part of the patchset has commit ID
3b12c21. The last patch I want to send has commit ID b7ca36a. So, I
want to pass the commit range {{{3b12c21^..b7ca36a}}} to {{{git format-
patch}}}. (Remember, the {{{git format-patch}}} range starting
commit must be the commit ''before'' the first commit you want to send,
so we use the '^' to specify the patch before commit 3b12c21). The
command will look something like this:

{{{
git format-patch -o /tmp/ --cover-letter -n --thread=shallow
3b12c21^..b7ca36a
}}}

Again, the -o flag specifies where to put the email files. The -n flag
says to add numbering to each patch (e.g. [PATCH 2/5]). The `--
thread=shallow` flag specifies that all patches will be In-Reply-To
your cover letter.

That will output files into /tmp:
{{{
/tmp/0000-cover-letter.patch
/tmp/0001-Trivial-docs-Remove-six-space-indentation-in-REPORTI.patch
/tmp/0002-Docs-Step-by-step-directions-for-reporting-bugs.patch
/tmp/0003-Docs-Add-Gather-info-section-to-REPORTING-BUGS.patch
/tmp/0004-Docs-Add-info-on-supported-kernels-to-REPORTING-BUGS.patch
/tmp/0005-Docs-Expectations-for-bug-reporters-and-maintainers.patch
/tmp/0006-Docs-Add-a-tips-section-to-REPORTING-BUGS.patch
/tmp/0007-Docs-Move-ref-to-Frohwalt-Egerer-to-end-of-REPORTING.patch
}}}

As you can see, there's an extra file called `0000-cover-letter.patch`.
This special file describes a list of commits in the patch series,
changed files and author information:

{{{
From a67edde382e1c4bc5068ce100a9370ede402695b Mon Sep 17 00:00:00 2001
Message-Id: <cover.1635340747.git.author@example.com>
From: Patchset Author <author@example.com>
Date: Wed, 27 Oct 2021 14:19:07 +0100
Subject: [PATCH 0/7] *** SUBJECT HERE ***

*** BLURB HERE ***

Patchset Author (7):
  Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
  Docs: Step-by-step directions for reporting bugs.
  Docs: Add "Gather info" section to REPORTING-BUGS.
  Docs: Add info on supported kernels to REPORTING-BUGS.
  Docs: Expectations for bug reporters and maintainers
  Docs: Add a tips section to REPORTING-BUGS.
  Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS

 REPORTING-BUGS |  162 ++++++++++++++++++++++++++++++++++++++++++++++--
--------
 1 files changed, 134 insertions(+), 28 deletions(-)

-- 
2.30.2
}}}

You need to modify this file before sending the patchset. In `***
SUBJECT HERE ***`, write a short description just like you did it for
single patches. In `*** BLURB HERE ***` briefly describe why your
patchset was created and what was changed and/or fixed.

To send the patchset, you need to provide a path that matches all of
the generated files. In this case, the `git send-email` command would
look like this:

{{{
git send-email --to <outreachy mailing list if required> --cc
<addresses from get_maintainer.pl output> /tmp/*.patch
}}}

If you would like to test your patchset emails before sending them, you
can add `--dry-run` option that will execute the command without
sending the actual emails. 

Re: [Outreachy kernel] Help maintain the First Patch Tutorial

[Alison Schofield]

On Wed, Oct 27, 2021 at 03:48:18PM +0100, Karolina Drobnik wrote:
> On Mon, 2021-10-25 at 09:30 -0700, Alison Schofield wrote:
> > Thanks for the update.
> > It seems that the original was lacking the fill in the cover letter
> > step...at least in this section. Going directly from format-patch >
> > to send-email on a patchset would send an empty cover letter.
> > See if you can fix that up.
> > Thanks!
> 
> Hi Alison,
> 
> I added a description on the cover letter file. Could you take a look
> and see if it looks alright?
> 
Thanks Karolina. It looks good. Please post it.
I expect that maintaining the tutorial is an iterative process.
We'll keep at it.

Alison


> 
> Thanks,
> Karolina
> 
> --------------------------------------------------------------------
> 
> <<Anchor(git_format_patch_patchset)>>
> == Using git format-patch to send patchsets ==
> 
> First, use {{{`git log --pretty=oneline --abbrev-commit`}}} to figure
> out the first commit ID you want to send. For example, say that my tree
> had this git log history:
> 
> {{{
> b7ca36a Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS
> bf6adaf Docs: Add a tips section to REPORTING-BUGS.
> bc6bed4 Docs: Expectations for bug reporters and maintainers
> 2c97a63 Docs: Add info on supported kernels to REPORTING-BUGS.
> 7883a25 Docs: Add "Gather info" section to REPORTING-BUGS.
> d60418b Docs: Step-by-step directions for reporting bugs.
> 3b12c21 Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
> bb33db7 Merge branches 'timers-urgent-for-linus', 'irq-urgent-for-
> linus' and 'core-urgent-for-linus' of
> git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
> 41ef2d5 Linux 3.9-rc7
> }}}
> 
> The first commit I want to send as part of the patchset has commit ID
> 3b12c21. The last patch I want to send has commit ID b7ca36a. So, I
> want to pass the commit range {{{3b12c21^..b7ca36a}}} to {{{git format-
> patch}}}. (Remember, the {{{git format-patch}}} range starting
> commit must be the commit ''before'' the first commit you want to send,
> so we use the '^' to specify the patch before commit 3b12c21). The
> command will look something like this:
> 
> {{{
> git format-patch -o /tmp/ --cover-letter -n --thread=shallow
> 3b12c21^..b7ca36a
> }}}
> 
> Again, the -o flag specifies where to put the email files. The -n flag
> says to add numbering to each patch (e.g. [PATCH 2/5]). The `--
> thread=shallow` flag specifies that all patches will be In-Reply-To
> your cover letter.
> 
> That will output files into /tmp:
> {{{
> /tmp/0000-cover-letter.patch
> /tmp/0001-Trivial-docs-Remove-six-space-indentation-in-REPORTI.patch
> /tmp/0002-Docs-Step-by-step-directions-for-reporting-bugs.patch
> /tmp/0003-Docs-Add-Gather-info-section-to-REPORTING-BUGS.patch
> /tmp/0004-Docs-Add-info-on-supported-kernels-to-REPORTING-BUGS.patch
> /tmp/0005-Docs-Expectations-for-bug-reporters-and-maintainers.patch
> /tmp/0006-Docs-Add-a-tips-section-to-REPORTING-BUGS.patch
> /tmp/0007-Docs-Move-ref-to-Frohwalt-Egerer-to-end-of-REPORTING.patch
> }}}
> 
> As you can see, there's an extra file called `0000-cover-letter.patch`.
> This special file describes a list of commits in the patch series,
> changed files and author information:
> 
> {{{
> From a67edde382e1c4bc5068ce100a9370ede402695b Mon Sep 17 00:00:00 2001
> Message-Id: <cover.1635340747.git.author@example.com>
> From: Patchset Author <author@example.com>
> Date: Wed, 27 Oct 2021 14:19:07 +0100
> Subject: [PATCH 0/7] *** SUBJECT HERE ***
> 
> *** BLURB HERE ***
> 
> Patchset Author (7):
>   Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
>   Docs: Step-by-step directions for reporting bugs.
>   Docs: Add "Gather info" section to REPORTING-BUGS.
>   Docs: Add info on supported kernels to REPORTING-BUGS.
>   Docs: Expectations for bug reporters and maintainers
>   Docs: Add a tips section to REPORTING-BUGS.
>   Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS
> 
>  REPORTING-BUGS |  162 ++++++++++++++++++++++++++++++++++++++++++++++--
> --------
>  1 files changed, 134 insertions(+), 28 deletions(-)
> 
> -- 
> 2.30.2
> }}}
> 
> You need to modify this file before sending the patchset. In `***
> SUBJECT HERE ***`, write a short description just like you did it for
> single patches. In `*** BLURB HERE ***` briefly describe why your
> patchset was created and what was changed and/or fixed.
> 
> To send the patchset, you need to provide a path that matches all of
> the generated files. In this case, the `git send-email` command would
> look like this:
> 
> {{{
> git send-email --to <outreachy mailing list if required> --cc
> <addresses from get_maintainer.pl output> /tmp/*.patch
> }}}
> 
> If you would like to test your patchset emails before sending them, you
> can add `--dry-run` option that will execute the command without
> sending the actual emails. 
> 
>