Commit log example

From Openembedded

Please Note: If you fail to follow the commit log guidelines without a good reason your commit may be reverted.

Instructions:

• The first words of a commit should be recipe name, normally without the version number.

• This is followed by a colon (:), space and a short (no more than a few words) description of the change.
• This should all be on one line and you should leave an empty line before any detailed commit information.

• Additional lines of the commit should detail the pertinent changes (much like a changelog) and are normally marked with *.

• The reasons for separation between the short one-line description and the long description (if present) with an empty line is to help with extracting and applying patches using git (git-format-patch/git-am). The short description becomes the Subject of the patch/email and without the empty line after it, the long description may get lost when the patch is sent via email.

Following this commit log policy will ensure consistent commit logs and proposals regardless of there origin (mailing list, patchworks, direct GIT commit etc.)

Example:

 rp-pppoe: Add version 3.8.

 * The source for version 3.5 hasn't been available for a long time.
 * Make sure pppoe is installed suid root.
 * Always try to reconnect, pppd handles stop/starting pppoe. This prevents
   lots of annoying problems with pppoe totally giving up (debian patch)
 * Accept PPPoE packets from multicast addresses (debian patch)
 * Don't check the version of the hosts ppp, we don't support the older
   versions of ppp anyway so just remove those checks.
 * RDEPEND on ppp, which is needed to use pppoe
 * Hard code pppd and id paths, don't search for them on the host system.