android: util: Add a mapping from VkFormat to PIPE_FORMAT.
[mesa.git] / docs / submittingpatches.html
index d8b9fc3b643d295af0675c04de38d474ae56f2a1..403f4295e78478ad824434fdc845d4a0fe3e5174 100644 (file)
@@ -42,9 +42,7 @@ components.
 <code>git bisect</code>.)
 <li>Patches should be properly <a href="#formatting">formatted</a>.
 <li>Patches should be sufficiently <a href="#testing">tested</a> before submitting.
-<li>Patches should be <a href="#submit">submitted</a>
-to <a href="#mailing">mesa-dev</a> or with
-a <a href="#merge-request">merge request</a>
+<li>Patches should be <a href="#submit">submitted</a> via a merge request</a>
 for <a href="#reviewing">review</a>.
 
 </ul>
@@ -75,17 +73,23 @@ if needed.  For example:
     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 pretty.fixes 'Fixes: %h ("%s")'</pre> once and then using <pre>git show -s --pretty=fixes &lt;sha1&gt;</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>
@@ -116,19 +120,6 @@ that should be documented with:
 <li>If sending later revision of a patch, add all the tags - ack, r-b,
 Cc: mesa-stable and/or other. This provides reviewers with quick feedback if the
 patch has already been reviewed.
-<li>In order for your patch to reach the prospective reviewer easier/faster,
-use the script scripts/get_reviewer.pl to get a list of individuals and include
-them in the CC list.
-<p>
-Please use common sense and do <strong>not</strong> blindly add everyone.
-</p>
-<pre>
-    $ scripts/get_reviewer.pl --help # to get the help screen
-    $ scripts/get_reviewer.pl -f src/egl/drivers/dri2/platform_android.c
-    Rob Herring &lt;robh@kernel.org&gt; (reviewer:ANDROID EGL SUPPORT,added_lines:188/700=27%,removed_lines:58/283=20%)
-    Tomasz Figa &lt;tfiga@chromium.org&gt; (reviewer:ANDROID EGL SUPPORT,authored:12/41=29%,added_lines:308/700=44%,removed_lines:115/283=41%)
-    Emil Velikov &lt;emil.l.velikov@gmail.com&gt; (authored:13/41=32%,removed_lines:76/283=27%)
-</pre>
 </ul>
 
 
@@ -168,67 +159,13 @@ replacing <code>"meson test"</code> with whatever other test you want to
 run.
 </p>
 
-
 <h2 id="submit">Submitting Patches</h2>
 
 <p>
-Patches may be submitted to the Mesa project by
-<a href="#mailing">email</a> or with a
-GitLab <a href="#merge-request">merge request</a>. To prevent
-duplicate code review, only use one method to submit your changes.
+Patches are submitted to the Mesa project via a
+<a href="https://gitlab.freedesktop.org/mesa/mesa">GitLab</a> Merge Request.
 </p>
 
-<h3 id="mailing">Mailing Patches</h3>
-
-<p>
-Patches may be sent to the mesa-dev mailing list for review:
-<a href="https://lists.freedesktop.org/mailman/listinfo/mesa-dev">
-mesa-dev@lists.freedesktop.org</a>.
-When submitting a patch make sure to use
-<a href="https://git-scm.com/docs/git-send-email">git send-email</a>
-rather than attaching patches to emails. Sending patches as
-attachments prevents people from being able to provide in-line review
-comments.
-</p>
-
-<p>
-When submitting follow-up patches you can use --in-reply-to to make v2, v3,
-etc patches show up as replies to the originals. This usually works well
-when you're sending out updates to individual patches (as opposed to
-re-sending the whole series). Using --in-reply-to makes
-it harder for reviewers to accidentally review old patches.
-</p>
-
-<p>
-When submitting follow-up patches you should also login to
-<a href="https://patchwork.freedesktop.org">patchwork</a> and change the
-state of your old patches to Superseded.
-</p>
-
-<p>
-Some companies' mail server automatically append a legal disclaimer,
-usually containing something along the lines of "The information in this
-email is confidential" and "distribution is strictly prohibited".
-</p>
-<p>
-These legal notices prevent us from being able to accept your patch,
-rendering the whole process pointless. Please make sure these are
-disabled before sending your patches. (Note that you may need to contact
-your email administrator for this.)
-</p>
-
-<h3 id="merge-request">GitLab Merge Requests</h3>
-
-<p>
-  <a href="https://gitlab.freedesktop.org/mesa/mesa">GitLab</a> Merge
-  Requests (MR) can also be used to submit patches for Mesa.
-</p>
-
-<p>
-  If the MR may have interest for most of the Mesa community, you can
-  send an email to the mesa-dev email list including a link to the MR.
-  Don't send the patch to mesa-dev, just the MR link.
-</p>
 <p>
   Add labels to your MR to help reviewers find it. For example:
 </p>
@@ -277,16 +214,15 @@ your email administrator for this.)
 <h2 id="reviewing">Reviewing Patches</h2>
 
 <p>
-  To participate in code review, you should monitor the
-  <a href="https://lists.freedesktop.org/mailman/listinfo/mesa-dev">
-  mesa-dev</a> email list and the GitLab
-  Mesa <a href="https://gitlab.freedesktop.org/mesa/mesa/merge_requests">Merge
-  Requests</a> page.
+  To participate in code review, you can monitor the GitLab Mesa
+ <a href="https://gitlab.freedesktop.org/mesa/mesa/merge_requests">Merge
+  Requests</a> page, and/or register for notifications in your gitlab
+  settings.
 </p>
 
 <p>
-When you've reviewed a patch on the mailing list, please be unambiguous
-about your review.  That is, state either
+When you've reviewed a patch, please be unambiguous about your review.
+  That is, state either
 </p>
 <pre>
     Reviewed-by: Joe Hacker &lt;jhacker@foo.com&gt;
@@ -487,11 +423,6 @@ commits before sending.
     git send-email --subject-prefix="PATCH v4" HEAD~8
     git send-email -v4 @~8 # shorter version, inherited from git format-patch
 </pre>
-<li> Configure git to use the get_reviewer.pl script interactively. Thus you
-can avoid adding the world to the CC list.
-<pre>
-    git config sendemail.cccmd "./scripts/get_reviewer.pl -i"
-</pre>
 </ul>