Re: [PATCH] Staging: comedi: dmm32at: Fixed a code indent issue

From: Konrad Zapalowicz
Date: Tue Jan 06 2015 - 08:33:37 EST


On 01/06, Sudip Mukherjee wrote:
> On Tue, Jan 06, 2015 at 10:08:37AM +0000, Ian Abbott wrote:
> > On 06/01/15 06:02, Sudip Mukherjee wrote:
> > >On Mon, Jan 05, 2015 at 08:24:06PM +0100, Piotr Kubus wrote:
> > >>On Sun, Jan 04, 2015 at 11:31:29PM +0100, Konrad Zapalowicz wrote:
> > >>>On 01/04, Piotr Kubus wrote:
> > >>>>This is a patch to the dmm32at.c file that fixes up a code indent error found by the checkpatch.pl tool.
> > >>>
> > >>>Nice however improve your commit message. The rule is that the lines
> > >>>should wrap at 72nd column except for quoted material such as compiler
> > >>>output, etc...
> > >>>
> > >>>The 72-character columns are important for allowing quoting and they
> > >>>play nicely with standard indentation from git log.
> > >>
> > >>Hey,
> > >>
> > >>I couldn't find that rule in Kernel documentation. Besides there were no
> > >>complaints from checkpatch.pl tool.
> > >
> > >Please check SubmittingPatches in Documentation. It says:
> > >'the "summary" must be no more than 70-75 characters'
> >
> > In this case, it's not the "summary" that's at issue, it's the body
> > of the commit message, as Konrad mentioned above.
>
> yes, i read the SubmittingPatches again. summary is the subject line. But then as Piotr Kubus has written that he could not find this rule in the documentaion, I also tried to find that in SubmittingPatches file and also in the Posting file of the development-process folder, but could not find it. Is it mentioned in some other file we missed ?

Then it is an 'unwritten rule' :) You can observe it just be browsing
the git log commit messages - pick a few random and you will see.

Moreover in the http://git-scm.com/book/ch5-2.html the 72-character
columns are the example of the good commit message plus Linus says so:

"we use 72-character columns for word-wrapping, except for quoted
material that has a specific line format."

in one of his comments
https://github.com/torvalds/linux/pull/17#issuecomment-5661185

cheers,
konrad

> sudip
> >
> > --
> > -=( Ian Abbott @ MEV Ltd. E-mail: <abbotti@xxxxxxxxx> )=-
> > -=( Web: http://www.mev.co.uk/ )=-
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/