<li>The first line should be a short, concise summary of the change prefixed
with a module name. Examples:
<pre>
- mesa: Add support for querying GL_VERTEX_ATTRIB_ARRAY_LONG
+mesa: Add support for querying GL_VERTEX_ATTRIB_ARRAY_LONG
- gallium: add PIPE_CAP_DEVICE_RESET_STATUS_QUERY
+gallium: add PIPE_CAP_DEVICE_RESET_STATUS_QUERY
- i965: Fix missing type in local variable declaration.
+i965: Fix missing type in local variable declaration.
</pre>
<li>Subsequent patch comments should describe the change in more detail,
if needed. For example:
<pre>
- i965: Remove end-of-thread SEND alignment code.
+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.
+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 an issue in gitlab, use the Closes: tag
For example:
<pre>
- Closes: https://gitlab.freedesktop.org/mesa/mesa/issues/1
+Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/1
</pre>
<p>Prefer the full url to just <code>Closes: #1</code>, since the url makes it
easier to get to the bug page from <code>git log</code></p>
<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"
+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>
<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
- fixup the texture case to use a stencil only format
- for picking the format for the texture view.
- v3: hit fallback for getteximage
- v4: put s8 back in front, it shouldn't get picked now (Ilia)
+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
+ fixup the texture case to use a stencil only format
+ for picking the format for the texture view.
+v3: hit fallback for getteximage
+v4: put s8 back in front, it shouldn't get picked now (Ilia)
</pre>
<li>If someone tested your patch, document it with a line like this:
<pre>
- Tested-by: Joe Hacker <jhacker@foo.com>
+Tested-by: Joe Hacker <jhacker@foo.com>
</pre>
<li>If the patch was reviewed (usually the case) or acked by someone,
that should be documented with:
<pre>
- Reviewed-by: Joe Hacker <jhacker@foo.com>
- Acked-by: Joe Hacker <jhacker@foo.com>
+Reviewed-by: Joe Hacker <jhacker@foo.com>
+Acked-by: Joe Hacker <jhacker@foo.com>
</pre>
<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
</p>
<p>
-As mentioned at the begining, patches should be bisectable.
+As mentioned at the beginning, patches should be bisectable.
A good way to test this is to make use of the `git rebase` command,
to run your tests on each commit. Assuming your branch is based off
<code>origin/master</code>, you can run:
<p>
To participate in code review, you can monitor the GitLab Mesa
- <a href="https://gitlab.freedesktop.org/mesa/mesa/merge_requests">Merge
+ <a href="https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests">Merge
Requests</a> page, and/or register for notifications in your gitlab
settings.
</p>
That is, state either
</p>
<pre>
- Reviewed-by: Joe Hacker <jhacker@foo.com>
+Reviewed-by: Joe Hacker <jhacker@foo.com>
</pre>
or
<pre>
- Acked-by: Joe Hacker <jhacker@foo.com>
+Acked-by: Joe Hacker <jhacker@foo.com>
</pre>
<p>
Rather than saying just "LGTM" or "Seems OK".
If small changes are suggested, it's OK to say something like:
</p>
<pre>
- With the above fixes, Reviewed-by: Joe Hacker <jhacker@foo.com>
+With the above fixes, Reviewed-by: Joe Hacker <jhacker@foo.com>
</pre>
<p>
which tells the patch author that the patch can be committed, as long
enclose the tag in backticks:
</p>
<pre>
- `Reviewed-by: Joe Hacker <jhacker@example.com>`</pre>
+`Reviewed-by: Joe Hacker <jhacker@example.com>`</pre>
<p>
This is the markdown format for literal, and will prevent gitlab from hiding
the < and > symbols.
</p>
<ul>
<li> By adding the Cc: mesa-stable@ tag as described below.
-<li> Sending the commit ID (as seen in master branch) to the mesa-stable@ mailing list.
-<li> Forwarding the patch from the mesa-dev@ mailing list.
+<li> By adding the fixes: tag as described below.
+<li> By submitting a merge request against the "staging/year.quarter" branch on gitlab.
</li>
</ul>
<p>
-Note: resending patch identical to one on mesa-dev@ or one that differs only
-by the extra mesa-stable@ tag is <strong>not</strong> recommended.
+Please <strong>DO NOT</strong> send patches to
+mesa-stable@lists.freedesktop.org, it is not monitored actively and is a
+historical artifact.
</p>
<p>
If you are not the author of the original patch, please Cc: them in your
</p>
<p>
+Using a "fixes tag" as described in <a href="#formatting">Patch formatting</a>
+is the preferred way to nominate a commit that you know ahead of time should be
+backported. There are scripts that will figure out which releases to apply the
+patch to automatically, so you don't need to figure it out.
+</p>
+
+<p>
+Alternatively, you may use a "CC:" tag.
+
Here are some examples of such a note:
</p>
<pre>
-CC: <mesa-stable@lists.freedesktop.org>
+CC: 20.0 19.3 <mesa-stable@lists.freedesktop.org>
</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
-for said branch the stable-release manager will reply stating so.
-
-This "CC" syntax for patch nomination will cause patches to automatically be
-copied to the mesa-stable@ mailing list when you use "git send-email" to send
-patches to the mesa-dev@ mailing list. If you prefer using --suppress-cc that
-won't have any negative effect on the patch nomination.
-
<p>
-Note: by removing the tag [as the commit is pushed] the patch is
-<strong>explicitly</strong> rejected from inclusion in the stable branch(es).
-Thus, drop the line <strong>only</strong> if you want to cancel the nomination.
+Using the CC tag <strong>should</strong> include the stable branches you want
+to nominate the patch to. If you do not provide any version it is nominated to
+all active stable branches.
</p>
-Alternatively, if one uses the "Fixes" tag as described in the "Patch formatting"
-section, it nominates a commit for all active stable branches that include the
-commit that is referred to.
-
<h2 id="criteria">Criteria for accepting patches to the stable branch</h2>
Mesa has a designated release manager for each stable branch, and the release
manager will reply to the patch in question stating why the patch has been
rejected or would request a backport.
-A summary of all the picked/rejected patches will be presented in the
-<a href="releasing.html#prerelease">pre-release</a> announcement.
-
The stable-release manager may at times need to force-push changes to the
stable branches, for example, to drop a previously-picked patch that was later
identified as causing a regression). These force-pushes may cause changes to
<h2 id="backports">Sending backports for the stable branch</h2>
<p>
-By default merge conflicts are resolved by the stable-release manager. In which
-case he/she should provide a comment about the changes required, alongside the
-<code>Conflicts</code> section. Summary of which will be provided in the
-<a href="releasing.html#prerelease">pre-release</a> announcement.
+By default merge conflicts are resolved by the stable-release manager. The
+release maintainer should resolve trivial conflicts, but for complex conflicts
+they should ask the original author to provide a backport or de-nominate the
+patch.
</p>
<p>
-Developers are interested in sending backports are recommended to use either a
-<code>[BACKPORT #branch]</code> subject prefix or provides similar information
-within the commit summary.
+For patches that either need to be nominated after they've landed in master, or
+that are known ahead of time to not not apply cleanly to a stable branch (such
+as due to a rename), using a gitlab MR is most appropriate.
+
+The MR should be based on and target the staging/year.quarter branch, not on
+the year.quarter branch, per the stable branch policy.
+
+Assigning the MR to release maintainer for said branch or mentioning them is
+helpful, but not required.
</p>
<h2 id="gittips">Git tips</h2>
<li><code>git rebase -i ...</code> is your friend. Don't be afraid to use it.
<li>Apply a fixup to commit FOO.
<pre>
- git add ...
- git commit --fixup=FOO
- git rebase -i --autosquash ...
+git add ...
+git commit --fixup=FOO
+git rebase -i --autosquash ...
</pre>
<li>Test for build breakage between patches e.g last 8 commits.
<pre>
- git rebase -i --exec="ninja -C build/" HEAD~8
+git rebase -i --exec="ninja -C build/" HEAD~8
</pre>
<li>Sets the default mailing address for your repo.
<pre>
- git config --local sendemail.to mesa-dev@lists.freedesktop.org
+git config --local sendemail.to mesa-dev@lists.freedesktop.org
</pre>
<li> Add version to subject line of patch series in this case for the last 8
commits before sending.
<pre>
- git send-email --subject-prefix="PATCH v4" HEAD~8
- git send-email -v4 @~8 # shorter version, inherited from git format-patch
+git send-email --subject-prefix="PATCH v4" HEAD~8
+git send-email -v4 @~8 # shorter version, inherited from git format-patch
</pre>
</ul>