| Message ID | 20250311072805.778362-1-dmkhn@proton.me (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: add explanation for 'Resolved:' | expand |
On Tuesday, March 11th, 2025 at 12:28 AM, dmkhn@proton.me <dmkhn@proton.me> wrote: > > > From: Denis Mukhin dmukhin@ford.com > > > '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@ford.com Whoops, I made a typo in the subject line of the commit message: s/Resolved/Resolves/ If all looks good, can I ask to fix the typo on commit? Thanks, Denis > > --- > 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 > + > ### Backport: > > A backport tag is an optional tag in the commit message to request a > -- > 2.34.1
On 2025-03-11 03:28, dmkhn@proton.me wrote: > From: Denis Mukhin <dmukhin@ford.com> > > '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@ford.com> With the commit title change, Reviewed-by: Jason Andryuk <jason.andryuk@amd.com> > --- > 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
On Tue, 11 Mar 2025, Jason Andryuk wrote: > On 2025-03-11 03:28, dmkhn@proton.me wrote: > > From: Denis Mukhin <dmukhin@ford.com> > > > > '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@ford.com> > > With the commit title change, > > Reviewed-by: Jason Andryuk <jason.andryuk@amd.com> Acked-by: Stefano Stabellini <sstabellini@kernel.org>
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 + ### Backport: A backport tag is an optional tag in the commit message to request a