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

[xen master] docs: add explanation for 'Resolves:'



commit ec7a279a23462270bfda949bcd1bbaee1f81555d
Author:     Denis Mukhin <dmukhin@xxxxxxxx>
AuthorDate: Tue Mar 11 07:28:26 2025 +0000
Commit:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CommitDate: Tue Mar 11 22:30:10 2025 +0000

    docs: add explanation for 'Resolves:'
    
    'Resolves:' tag may be used if the patch addresses one of the tickets
    logged via Gitlab to auto-close such ticket when the patch got merged.
    
    Add documentation for the tag.
    
    Resolves: https://gitlab.com/xen-project/xen/-/issues/199
    Signed-off-by: Denis Mukhin <dmukhin@xxxxxxxx>
    Reviewed-by: Jason Andryuk <jason.andryuk@xxxxxxx>
    Acked-by: Stefano Stabellini <sstabellini@xxxxxxxxxx>
---
 docs/process/sending-patches.pandoc | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/process/sending-patches.pandoc 
b/docs/process/sending-patches.pandoc
index 2e74c3b57e..1991932b68 100644
--- a/docs/process/sending-patches.pandoc
+++ b/docs/process/sending-patches.pandoc
@@ -106,6 +106,18 @@ 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.
 
+### Resolves:
+
+If your patch addresses an issue logged in a GitLab ticket, use the `Resolves:`
+tag followed by the issue link to automatically close the ticket when the patch
+is merged.
+
+    Resolves: <URL>
+
+E.g.:
+
+    Resolves: https://gitlab.com/xen-project/xen/-/issues/199
+
 ### Backport:
 
 A backport tag is an optional tag in the commit message to request a
--
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®.