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

[Karolina Drobnik <karolinadrobnik@gmail.com>]

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.