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

[Alison Schofield <alison.schofield@intel.com>]

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.