Re: [PATCH net-next]atl1c: Add AR8151 v2 support and change L0s/L1routine

[David Miller]

From: <jie.yang@xxxxxxxxxxx>
Date: Fri, 28 May 2010 15:40:38 +0800

> From: Jie.Yang@xxxxxxxxxxx
> 
> Add AR8151 v2.0 Gigabit 1000 support
> Change jumbo frame size to 6K
> Update L0s/L1 rountine
> Update atl1c_suspend routine.
> 
> Signed-off-by: Jie.Yang@xxxxxxxxxxx

Your commit log message is way too terse.

You should describe in detail what your changes are.

Saying "Update L0s/L1 routine" doesn't tell us exactly what change
you are making.  And more importantly, it does not tell us why you
are making this change.

This also applied to "update atl1c_suspend routine" You have to
list exactly change you are making, and why.

You should be able to write a full paragraph explaining what each
change is, and the reason for that change.  This means 4 to 5 full
english sentences, which means more than 3 or 4 words in each
sentence.

Do not try to put as minimal amount of information into your commit
messages as possible, instead strive to put too much information.
Be long winded, and verbose, because you cannot predict what details
of your change and reasoning will be important to someone in the future.

Because some day someone will read your commit patch and wonder the
reasons why you made your changes.

I am not applying this patch until the commit message is made more
verbose and reasonable.
--
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/