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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 





On Fri, Sep 30, 2016, 1:22 PM <Valdis.Kletnieks@xxxxxx> wrote:
On Fri, 30 Sep 2016 07:49:50 +0200, Bjørn Mork said:

> 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.

And to add to what he said:

Explaining the *why* is better than the *how*.

"Add Documentation/initest.txt" isn't that helpful - we can see from the diff
that's what it does.  "Add documentation explaining how to deal with the
Frobnizz  3000's wonky interrupts" is a lot better.

Similarly, "fix off-by-one error" is OK - but extending it to "fix off-by-one
error that causes the wireless card to select the wrong channel" is a lot better.

Sell us that patch - tell us *why* we want it in the kernel, and why we should
spend time reviewing it....

Please, you should not bother to review this patch seriously. As I have written in
this patch that "this patch is a test patch", not real one. It has been answered by Mr. Bjorn Mork
and you. This patch was merely to check whether my patch format is acceptable to the kernel
community.
--

Regards,
Amit Kumar
Twitter: @freeark1
Only Numbers Can Command.

_______________________________________________
Kernelnewbies mailing list
Kernelnewbies@xxxxxxxxxxxxxxxxx
https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies

[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux