[Buildroot] [PATCH] docs/manual: standardize a bit more the formatting of commit titles

Peter Korsgaard peter at korsgaard.com
Sun Nov 25 08:56:20 UTC 2018


>>>>> "Peter" == Peter Korsgaard <peter at korsgaard.com> writes:

>>>>> "Carlos" == Carlos Santos <casantos at datacom.com.br> writes:
 > Hi,

 >>> First of all, it is essential that the patch has a good commit
 >>> message. The commit message should start with a separate line with a
 >>> -brief summary of the change, starting with the name of the affected
 >>> -package. The body of the commit message should describe _why_ this
 >>> +brief summary of the change, prefixed by the area touched by the
 >>> +patch. A few examples of good commit titles:
 >>> +
 >>> +* +package/linuxptp: bump version to 2.0+

 >> Looks good, but isn't "package/" a bit superfluous, since Most of the
 >> commits are for packages? It also goes against the tradition:

 >> $ git log --oneline origin/master | grep -i '^.......... [^ /]*: bump' |wc -l
 >> 7644
 >> $ git log --oneline origin/master | grep -i '^.......... [^ ]*/[^ ]*: bump' |wc -l
 >> 2296

 > I also personally prefer without package/, but consistency and
 > documentation in the manual is nice, so Ok for me.

Next to the purely subjective preference, there is also the issue of
running into the max subject length with long package paths, E.G.:

package/freescale-imx/kernel-module-imx-gpu-viv: <blah>
package/x11r7/xfont_font-bh-lucidatypewriter-100dpi: <blih>
package/python-backports-shutil-get-terminal-size: <bloh>

-- 
Bye, Peter Korsgaard


More information about the buildroot mailing list