Hi, Duy Nguyen wrote: > On Wed, Dec 19, 2018 at 6:04 PM Ævar Arnfjörð Bjarmason >> E.g. when composing >> https://public-inbox.org/git/878t0lfwrj.fsf@xxxxxxxxxxxxxxxxxxx/ I >> remembered PERLLIB_EXTRA went back & forth between >> working/breaking/working with your/my/your patch, so: >> >> git log --grep=0386dd37b1 >> >> Just found the chain up to my breaking change, but not your 7a7bfc7adc, >> which refers to that commit as v1.9-rc0~88^2. [...] > To follow email model, this sounds like a good trailer for related > commits, like In-Reply-To for email. We could even have special > trailer "Fixes" to indicate what commit is the problem that this > commit fixes. In Linux kernel land, Documentation/process/submitting-patches.rst contains the following: -- >8 -- If your patch fixes a bug in a specific commit, e.g. you found an issue using ``git bisect``, please use the 'Fixes:' tag with the first 12 characters of the SHA-1 ID, and the one line summary. For example:: Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()") The following ``git config`` settings can be used to add a pretty format for outputting the above style in the ``git log`` or ``git show`` commands:: [core] abbrev = 12 [pretty] fixes = Fixes: %h (\"%s\") -- 8< -- I like it because (1) the semantics are clear, (2) it's very concrete (e.g. "first 12 characters", (3) it goes in a trailer, where other bits intended for machine consumption already go. Should we adopt it? In other words, how about something like the following? If it seems like a good idea, I can add a commit message. Signed-off-by: Jonathan Nieder <jrnieder@xxxxxxxxx> diff --git i/Documentation/SubmittingPatches w/Documentation/SubmittingPatches index ec8b205145..36ce1ac5d8 100644 --- i/Documentation/SubmittingPatches +++ w/Documentation/SubmittingPatches @@ -367,6 +367,20 @@ If you like, you can put extra tags at the end: You can also create your own tag or use one that's in common usage such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:". +If your patch fixes a bug in a specific commit, e.g. you found an issue using +``git bisect``, please use the 'Fixes:' tag with the first 12 characters of +the SHA-1 ID, and the one line summary. For example:: + + Fixes: 539047c19e ("revert: introduce --abort to cancel a failed cherry-pick") + +The following ``git config`` settings can be used to add a pretty format for +outputting the above style in the ``git log`` or ``git show`` commands:: + + [core] + abbrev = 12 + [pretty] + fixes = Fixes: %h (\"%s\") + == Subsystems with dedicated maintainers Some parts of the system have dedicated maintainers with their own
