docs: Add use of Closes: tag for closing gitlab issues

[mesa.git] / docs / submittingpatches.html

diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html
index 81fa4cddea70d566aac7dafd3dcb0511384b4277..96aed289311572e74fb590d3699575652b089d07 100644 (file)
--- a/docs/submittingpatches.html
+++ b/docs/submittingpatches.html
@@ -68,32 +68,39 @@ with a module name.  Examples:
 if needed.  For example:
 <pre>
     i965: Remove end-of-thread SEND alignment code.
-    
+
     This was present in Eric's initial implementation of the compaction code
     for Sandybridge (commit 077d01b6). There is no documentation saying this
     is necessary, and removing it causes no regressions in piglit on any
     platform.
 </pre>
 <li>A "Signed-off-by:" line is not required, but not discouraged either.
-<li>If a patch addresses a bugzilla issue, that should be noted in the
-patch comment.  For example:
+<li>If a patch addresses an issue in gitlab, use the Closes: tag
+For example:
 <pre>
-   Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=89689
+    Closes: https://gitlab.freedesktop.org/mesa/mesa/issues/1
 </pre>
+<p>Prefer the full url to just <pre>Closes: #1</pre>, since the url makes it
+easier to get to the bug page from <pre>git log</pre></p>
+<b>Do not use the Fixes: tag for this!</b> Mesa already uses Fixes for something else.
+
 <li>If a patch addresses a issue introduced with earlier commit, that should be
 noted in the patch comment.  For example:
 <pre>
    Fixes: d7b3707c612 "util/disk_cache: use stat() to check if entry is a directory"
 </pre>
+<li>You can produce those fixes lines by running
+<pre>git config --global alias.fixes "show -s --pretty='format:Fixes: %h (\"%s\")'"</pre>
+once and then using <pre>git fixes &lt;sha1&gt;</pre>
 <li>If there have been several revisions to a patch during the review
 process, they should be noted such as in this example:
 <pre>
     st/mesa: add ARB_texture_stencil8 support (v4)
-    
+
     if we support stencil texturing, enable texture_stencil8
     there is no requirement to support native S8 for this,
     the texture can be converted to x24s8 fine.
-    
+
     v2: fold fixes from Marek in:
        a) put S8 last in the list
        b) fix renderable to always test for d/s renderable
@@ -368,9 +375,9 @@ you should add an appropriate note to the commit message.
 <p>
 Here are some examples of such a note:
 </p>
-<ul>
-  <li>CC: &lt;mesa-stable@lists.freedesktop.org&gt;</li>
-</ul>
+<pre>
+CC: &lt;mesa-stable@lists.freedesktop.org&gt;
+</pre>
 
 Simply adding the CC to the mesa-stable list address is adequate to nominate
 the commit for all the active stable branches. If the commit is not applicable