[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] docs/sending-patches: document "Amends:" tag



commit c08845e230f160d8b25347a4df68c2195dd03e4b
Author:     Jan Beulich <jbeulich@xxxxxxxx>
AuthorDate: Thu Sep 4 16:54:47 2025 +0200
Commit:     Jan Beulich <jbeulich@xxxxxxxx>
CommitDate: Thu Sep 4 16:54:47 2025 +0200

    docs/sending-patches: document "Amends:" tag
    
    On rare occasions Fixes: isn't quite appropriate to use, yet another
    commit still wants making a connection to in a formalized way. Such could
    e.g. happen if a pretty obvious optimization was left out (which isn't a
    bug, but still a shortcoming). Formalize Amends: as a tage to use in such
    a situation.
    
    Requested-by: Roger Pau Monné <roger.pau@xxxxxxxxxx>
    Signed-off-by: Jan Beulich <jbeulich@xxxxxxxx>
    Acked-by: Michal Orzel <michal.orzel@xxxxxxx>
---
 docs/process/sending-patches.pandoc | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/process/sending-patches.pandoc 
b/docs/process/sending-patches.pandoc
index 1991932b68..798ecceb39 100644
--- a/docs/process/sending-patches.pandoc
+++ b/docs/process/sending-patches.pandoc
@@ -42,7 +42,7 @@ should be mentioned.
 
 When referencing other patches (e.g. `similar to patch xy ...`) those
 patches should be referenced via their commit id (at least 12 digits)
-and the patch subject, if the very same patch isn't referenced by the
+and the patch subject, if the very same patch isn't referenced by e.g. a
 `Fixes:` tag, too:
 
     Similar to commit 67d01cdb5518 ("x86: infrastructure to allow converting
@@ -106,6 +106,12 @@ If git was configured as explained earlier, this can be 
retrieved using
 ``git log --pretty=fixes`` otherwise ``git log --abbrev=12 --oneline`` will
 give the proper tag and commit-id.
 
+### Amends:
+
+If your patch doesn't quite fix a bug, but still amends a specific commit,
+e.g. because an omission was found, please consider using an `Amends:` tag.
+See the `Fixes:` tag description above for how to use it.
+
 ### Resolves:
 
 If your patch addresses an issue logged in a GitLab ticket, use the `Resolves:`
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.