[PATCH] INITEST: Documentation: Explains how INITEST works.

[Amit Kumar]

Hi,

Thank you for your reply.
I'll follow your suggestion.

On Fri, Sep 30, 2016, 11:19 AM Bjørn Mork <bjorn at mork.no> wrote:

> Amit Kumar <free.amit.kumar at gmail.com> writes:
>
> > Signed-off-by: Amit Kumar <free.amit.kumar at gmail.com>
> >
> > This is a test patch.
> > Is this patch in right format?
> > ---
> >  Documentation/initest.txt | 7 +++++++
> >  1 file changed, 7 insertions(+)
> >  create mode 100644 Documentation/initest.txt
> >
> > diff --git a/Documentation/initest.txt b/Documentation/initest.txt
> > new file mode 100644
> > index 0000000..eed4124
> > --- /dev/null
> > +++ b/Documentation/initest.txt
> > @@ -0,0 +1,7 @@
> > +INITEST
> > +
> > +1) This is the same user space program /sbin/init, but for the purpose
> of testing kernel system calls.
> > +
> > +2) It will also use testing drivers to test internal kernel API.
> > +
> > +3) This is a test patch.
>
>
> Looks pretty good.  But a few more things to keep in mind:
>
> 1) There should be *some* body text describing the patch, even for a very
>    basic change which is explained in full in subject.  This goes first
>    in the body, separated from the tags with a single empty line.
>
> 2) Signed-off-by and other tags go at the end of the body, right before
>   the "---" separator.  Don't put anything between the SOB and the
>   separator.  I realize that this was just a question that you wouldn't
>   make part of the submitted patch but still: It broke your example...
>
> 3) There is a place for questions about the patch which you do not want
>   to be part of the commit message: Right After the first "---"
>   separator.  Anything yout put there will be ignored by git when the
>   patch is applied, just like the diffstat git includes by itself.
>
>   This is useful if you need to explain something to the maintainer
>   regarding how to apply the patch, or if ytou have questions about it
>   which are irrelevant if applied.
>
>
>
> So the end result would be:
>
>
> Subject: [PATCH] INITEST: Documentation: Explains how INITEST works.
>
> This is a test patch.
>
> Signed-off-by: Amit Kumar <free.amit.kumar at gmail.com>
> ---
> Is this patch in right format?
>
>
> Documentation/initest.txt | 7 +++++++
> 1 file changed, 7 insertions(+)
> create mode 100644 Documentation/initest.txt
>
> diff --git a/Documentation/initest.txt b/Documentation/initest.txt
> [etc]
>
>
>
> Bjørn
>
-- 

Regards,
Amit Kumar
Twitter: @freeark1
Only Numbers Can Command.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.kernelnewbies.org/pipermail/kernelnewbies/attachments/20160930/a80d3985/attachment-0001.html