[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs: add explanation for 'Resolved:'
- To: <dmkhn@xxxxxxxxx>, <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- From: Jason Andryuk <jason.andryuk@xxxxxxx>
- Date: Tue, 11 Mar 2025 15:12:22 -0400
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=proton.me smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0)
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=yAq9LAI09hmZ0pSI0FVb34PvYl3m6Ujrztbyo1DIHeU=; b=aN0QGsz4QKuYDSAymXAW9yPR/avDZZSGLCwhtmYqvXXlTTb931fQJVykCkgAQZVFMa/QuIOygh8Ke/UPnv/iRyP1wgj3jKgwbrKKqaPUUtBng+P6GyGoNMowA0u1fJbJSSAf3i/f5sFJXmOrQNut92C2sAb8GQj4B9nv0wjanGJ5J+5eiJ8eaadkjcUUnGzcETAaGpqmlXfWuyQ2e04GzWEVmeM4uLLXPL9QgruCe0qwZ8N4ITqAVYPJHYCOQhg0cheULh3cXMKu5lZtbxtbjrvDpAMkGOgFpf9TkVuhiNtAwfhHBYWCuvqD6HTBy7YoNtNLzzUcJ5U5xXvoSUCkOw==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=wWdgP0GeDdodL25s3VNNe8tPsMm0+6w6Efw+7cvEgya1X21x92MFR73p8cEV0FFMxkoNLMsCLoG7hou+beEoCLDKULIlXpaIV7NMcJ9UF6w7Q0khG0lypvvujV6rDUx9E1UYbUdhihfCUf6N24ye6uWA5xpf2V+TkeGO1KEy4ylWA9s0AT01tK/8ccq2DIwPF+5/46/Wn1fX/RZHhrJgZO2JLGps4Kq9gzJxALnil4L7TObsQLFFG/N1A49FA46zH4Y9Js4IPX/JDYdFJL272qrMK0CZ7w6X2rO2Z4pFo90e1QrpPslpfj/Ig23x3rCZWsBUzJsgUt3cxHaJLOUCJw==
- Cc: <andrew.cooper3@xxxxxxxxxx>, <anthony.perard@xxxxxxxxxx>, <jbeulich@xxxxxxxx>, <julien@xxxxxxx>, <michal.orzel@xxxxxxx>, <roger.pau@xxxxxxxxxx>, <sstabellini@xxxxxxxxxx>, <dmukhin@xxxxxxxx>
- Delivery-date: Tue, 11 Mar 2025 19:12:34 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
On 2025-03-11 03:28, dmkhn@xxxxxxxxx wrote:
From: Denis Mukhin <dmukhin@xxxxxxxx>
'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.
Signed-off-by: Denis Mukhin <dmukhin@xxxxxxxx>
With the commit title change,
Reviewed-by: Jason Andryuk <jason.andryuk@xxxxxxx>
---
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..9fc3b407ff 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/185
(I'd find it funny if you created a new issue about documenting
"Resolved:" to place as the example.)
Regards,
Jason
|
