Mesa (master): docs/releasing: document how to squash/ announce queued patches
Emil Velikov
evelikov at kemper.freedesktop.org
Thu Mar 16 13:28:00 UTC 2017
Module: Mesa
Branch: master
Commit: ccb89e72aa177ee5f95a8f5985e5aab037bd2aa7
URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=ccb89e72aa177ee5f95a8f5985e5aab037bd2aa7
Author: Emil Velikov <emil.velikov at collabora.com>
Date: Wed Mar 15 17:34:26 2017 +0000
docs/releasing: document how to squash/announce queued patches
In the odd case where a patch needs to be fixed, squash the appropriate
fix and document how. Add a note in the pre-release notes, such that
devs can quickly spot it.
v2: Grammar/typo fixes (Eric). Use upstream commit [SHA] as reference.
Signed-off-by: Emil Velikov <emil.velikov at collabora.com>
Reviewed-by: Eric Engestrom <eric.engestrom at imgtec.com>
---
docs/releasing.html | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/docs/releasing.html b/docs/releasing.html
index 4db30c2c7a..b5a9a5c85b 100644
--- a/docs/releasing.html
+++ b/docs/releasing.html
@@ -115,6 +115,38 @@ performed where possible.
Achieved by combination of local ad-hoc scripts and AppVeyor plus Travis-CI,
the latter as part of their Github integration.
</p>
+<p>
+<strong>Note:</strong> If a patch in the current queue needs any additional
+fix(es), then they should be squashed together.
+<br>
+The commit messages and the <code>cherry picked from</code> tags must be preserved.
+</p>
+<p>
+This should be noted in the <a href="#prerelease">pre-announce</a> email.
+<pre>
+ git show b10859ec41d09c57663a258f43fe57c12332698e
+
+ commit b10859ec41d09c57663a258f43fe57c12332698e
+ Author: Jonas Pfeil <pfeiljonas at gmx.de>
+ Date: Wed Mar 1 18:11:10 2017 +0100
+
+ ralloc: Make sure ralloc() allocations match malloc()'s alignment.
+
+ The header of ralloc needs to be aligned, because the compiler assumes
+ ...
+
+ (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
+
+ Squashed with commit:
+
+ ralloc: don't leave out the alignment factor
+
+ Experimentation shows that without alignment factor gcc and clang choose
+ ...
+
+ (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
+</pre>
+</p>
<h2>Regression/functionality testing</h2>
@@ -290,6 +322,12 @@ Queued (NUMBER)
AUTHOR (NUMBER):
COMMIT SUMMARY
+For example:
+
+Jonas Pfeil (1):
+ ralloc: Make sure ralloc() allocations match malloc()'s alignment.
+Squashed with
+ ralloc: don't leave out the alignment factor
Rejected (NUMBER)
=================
More information about the mesa-commit
mailing list