Patch and Commit message guidelines -- first draft

Stefan Schmidt stefan at datenfreihafen.org
Mon Mar 7 08:43:43 UTC 2011


Hello.

On Fri, 2011-03-04 at 19:14, Khem Raj wrote:
> 
> We have two things. One is the patch to OE metadata which this
> covers pretty nicely. Second is the patches one generates to some
> packages to
> fix package problems/features etc. We should also define guidelines on
> those patches. I think its important to mention source of the patch and
> if it should be pushed to upstream for that given package and side
> effects of the patch symptoms it fixes etc etc.

Fully agreed. I think for patches against external code need to force a patch
header as well. Additional to the descriped above I would like to have a tag for
the patch status regarding upstream. Something like:

Patch-upstream-status: {upstream rev, bug tracker id, OE only, ...}

Tracking changes for all the patches in OE might be hard thought. Normally we
just realize that we don't need them anymore when updating a recipe.

> There is commit guidelines on OE wiki
> 
> http://openembedded.org/index.php/Commit_Policy

Reading that one reminds me that the review process is not descriped. Thought it
may be a different doc as it is a process and not the patch/commit format. :)

> http://openembedded.org/index.php/Commit_log_example

We may want to merge in some of the format bits from here.

regards
Stefan Schmidt




More information about the tsc mailing list