diff mbox

[1/2] Adding document for sparse patch submit process

Message ID CANeU7Qm9+-++i6U9DYXn-NYVj-k4r63JkK3srESyboTxQiP=4g@mail.gmail.com (mailing list archive)
State Superseded, archived
Headers show

Commit Message

Christopher Li Aug. 10, 2017, 3:27 a.m. UTC
Reference to the linux kernel patches submitting process
and difference to sparse.

Signed-off-by: Christopher Li <sparse@chrisli.org>
---
 Documentation/submitting-patches.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 Documentation/submitting-patches.md

+   Notice that sparse is MIT License.
+

Comments

Randy Dunlap Aug. 10, 2017, 7:36 p.m. UTC | #1
On 08/09/2017 08:27 PM, Christopher Li wrote:
> Reference to the linux kernel patches submitting process
> and difference to sparse.
> 
> Signed-off-by: Christopher Li <sparse@chrisli.org>
> ---
>  Documentation/submitting-patches.md | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>  create mode 100644 Documentation/submitting-patches.md
> 
> diff --git a/Documentation/submitting-patches.md
> b/Documentation/submitting-patches.md
> new file mode 100644
> index 0000000..f526d44
> --- /dev/null
> +++ b/Documentation/submitting-patches.md
> @@ -0,0 +1,21 @@
> +Submitting patches: the sparse version
> +======================================
> +
> +Sparse use a patch submit process similar to the Linux Kernel

          uses

> +[Submitting Patches](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html)
> +
> +This document mostly focus on the parts might be different from the Linux

                        focuses on the parts that might be

> +Kernel submitting process.
> +
> +1. Git clone a sparse repository:
> +
> +        git clone git://git.kernel.org/pub/scm/devel/sparse/sparse.git
> +
> +2. [Coding Style](https://www.kernel.org/doc/html/v4.12/process/coding-style.html)
> remain the same.

  remains

> +
> +2. Sign off the patch.

3. instead of 2. ??

> +
> +   The usage of the Signed-off-by tag is the same as [Linux Kernel
> Sign your work](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin).
> +
> +   Notice that sparse is MIT License.

                  sparse uses the MIT License.

> +
>
Christopher Li Aug. 10, 2017, 7:45 p.m. UTC | #2
On Thu, Aug 10, 2017 at 3:36 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> On 08/09/2017 08:27 PM, Christopher Li wrote:
>> Reference to the linux kernel patches submitting process
>> and difference to sparse.
>>
>> Signed-off-by: Christopher Li <sparse@chrisli.org>
>> ---
>>  Documentation/submitting-patches.md | 21 +++++++++++++++++++++
>>  1 file changed, 21 insertions(+)
>>  create mode 100644 Documentation/submitting-patches.md
>>
>> diff --git a/Documentation/submitting-patches.md
>> b/Documentation/submitting-patches.md
>> new file mode 100644
>> index 0000000..f526d44
>> --- /dev/null
>> +++ b/Documentation/submitting-patches.md
>> @@ -0,0 +1,21 @@
>> +Submitting patches: the sparse version
>> +======================================
>> +
>> +Sparse use a patch submit process similar to the Linux Kernel
>
>           uses

Great Great.

That is exactly the feed back I need :-)

I will incarcerate your feed back and send out an update very soon.


>
>> +
>> +2. Sign off the patch.
>
> 3. instead of 2. ??

Yes, I can use 3.  The exact number does not matter to MD parsing,
but using 3 will make the reader less confusing.

Chris
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/submitting-patches.md
b/Documentation/submitting-patches.md
new file mode 100644
index 0000000..f526d44
--- /dev/null
+++ b/Documentation/submitting-patches.md
@@ -0,0 +1,21 @@ 
+Submitting patches: the sparse version
+======================================
+
+Sparse use a patch submit process similar to the Linux Kernel
+[Submitting Patches](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html)
+
+This document mostly focus on the parts might be different from the Linux
+Kernel submitting process.
+
+1. Git clone a sparse repository:
+
+        git clone git://git.kernel.org/pub/scm/devel/sparse/sparse.git
+
+2. [Coding Style](https://www.kernel.org/doc/html/v4.12/process/coding-style.html)
remain the same.
+
+2. Sign off the patch.
+
+   The usage of the Signed-off-by tag is the same as [Linux Kernel
Sign your work](https://www.kernel.org/doc/html/v4.12/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin).
+