1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <meta http-equiv=
"content-type" content=
"text/html; charset=utf-8">
5 <title>Releasing process
</title>
6 <link rel=
"stylesheet" type=
"text/css" href=
"mesa.css">
11 <h1>The Mesa
3D Graphics Library
</h1>
14 <iframe src=
"contents.html"></iframe>
18 <h1>Releasing process
</h1>
21 <li><a href=
"#overview">Overview
</a>
22 <li><a href=
"#schedule">Release schedule
</a>
23 <li><a href=
"#pickntest">Cherry-pick and test
</a>
24 <li><a href=
"#branch">Making a branchpoint
</a>
25 <li><a href=
"#prerelease">Pre-release announcement
</a>
26 <li><a href=
"#release">Making a new release
</a>
27 <li><a href=
"#announce">Announce the release
</a>
28 <li><a href=
"#website">Update the mesa3d.org website
</a>
29 <li><a href=
"#bugzilla">Update Bugzilla
</a>
33 <h1 id=
"overview">Overview
</h1>
36 This document uses the convention X.Y.Z for the release number with X.Y being
37 the stable branch name.
39 Mesa provides feature and bugfix releases. Former use zero as patch version (Z),
40 while the latter have a non-zero one.
47 Mesa
10.1.0 -
10.1 branch, feature
48 Mesa
10.1.4 -
10.1 branch, bugfix
49 Mesa
12.0.0 -
12.0 branch, feature
50 Mesa
12.0.2 -
12.0 branch, bugfix
54 <h1 id=
"schedule">Release schedule
</h1>
57 Releases should happen on Fridays. Delays can occur although those should be keep
60 See our
<a href=
"release-calendar.html" target=
"_parent">calendar
</a> for the
61 date and other details for individual releases.
64 <h2>Feature releases
</h2>
66 <li>Available approximately every three months.
67 <li>Initial timeplan available
2-
4 weeks before the planned branchpoint (rc1)
68 on the mesa-announce@ mailing list.
69 <li>A
<a href=
"#prerelease">pre-release
</a> announcement should be available
70 approximately
24 hours before the final (non-rc) release.
73 <h2>Stable releases
</h2>
75 <li>Normally available once every two weeks.
76 <li>Only the latest branch has releases. See note below.
77 <li>A
<a href=
"#prerelease">pre-release
</a> announcement should be available
78 approximately
48 hours before the actual release.
82 Note: There is one or two releases overlap when changing branches. For example:
84 The final release from the
12.0 series Mesa
12.0.5 will be out around the same
85 time (or shortly after)
13.0.1 is out.
89 <h1 id=
"pickntest">Cherry-picking and testing
</h1>
92 Commits nominated for the active branch are picked as based on the
93 <a href=
"submittingpatches.html#criteria" target=
"_parent">criteria
</a> as
94 described in the same section.
98 Nomination happens in the mesa-stable@ mailing list. However,
99 maintainer is resposible of checking for forgotten candidates in the
100 master branch. This is achieved by a combination of ad-hoc scripts and
101 a casual search for terms such as regression, fix, broken and similar.
105 Maintainer is also responsible for testing in various possible permutations of
106 the autoconf and scons build.
109 <h2>Cherry-picking and build/check testing
</h2>
111 <p>Done continuously up-to the
<a href=
"#prerelease">pre-release
</a> announcement.
</p>
114 As an exception, patches can be applied up-to the last ~
1h before the actual
115 release. This is made
<strong>only
</strong> with explicit permission/request,
116 and the patch
<strong>must
</strong> be very well contained. Thus it cannot
117 affect more than one driver/subsystem.
121 Currently Ilia Mirkin and AMD devs have requested
"permanent" exception.
125 <li>make distcheck, scons and scons check must pass
126 <li>Testing with different version of system components - LLVM and others is also
127 performed where possible.
128 <li>As a general rule, testing with various combinations of configure
129 switches, depending on the specific patchset.
133 Achieved by combination of local ad-hoc scripts, mingw-w64 cross
134 compilation and AppVeyor plus Travis-CI, the latter as part of their
139 For Windows related changes, the main contact point is Brian
140 Paul. Jose Fonseca can also help as a fallback contact.
144 For Android related changes, the main contact is Tapani
145 P
älli. Mauro Rossi is collaborating with android-x86 and may
146 provide feedback about the build status in that project.
150 For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
155 <strong>Note:
</strong> If a patch in the current queue needs any additional
156 fix(es), then they should be squashed together.
158 The commit messages and the
<code>cherry picked from
</code> tags must be preserved.
162 This should be noted in the
<a href=
"#prerelease">pre-announce
</a> email.
166 git show b10859ec41d09c57663a258f43fe57c12332698e
168 commit b10859ec41d09c57663a258f43fe57c12332698e
169 Author: Jonas Pfeil
<pfeiljonas@gmx.de
>
170 Date: Wed Mar
1 18:
11:
10 2017 +
0100
172 ralloc: Make sure ralloc() allocations match malloc()'s alignment.
174 The header of ralloc needs to be aligned, because the compiler assumes
177 (cherry picked from commit cd2b55e536dc806f9358f71db438dd9c246cdb14)
179 Squashed with commit:
181 ralloc: don't leave out the alignment factor
183 Experimentation shows that without alignment factor gcc and clang choose
186 (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
189 <h2>Regression/functionality testing
</h2>
192 Less often (once or twice), shortly before the pre-release announcement.
193 Ensure that testing is redone if Intel devs have requested an exception, as per above.
197 <li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms
</em>
198 <li><em>no regressions should be observed for Piglit using the swrast, softpipe
199 and llvmpipe drivers
</em>
203 Currently testing is performed courtesy of the Intel OTC team and their Jenkins CI setup. Check with the Intel team over IRC how to get things setup.
207 Installing the built driver from the pre-announced RC branch in the
208 system and making some every day's use until the release may be a good
213 <h1 id=
"branch">Making a branchpoint
</h1>
216 A branchpoint is made such that new development can continue in parallel to
217 stabilisation and bugfixing.
221 Note: Before doing a branch ensure that basic build and
<code>make check
</code>
222 testing is done and there are little to-no issues.
224 Ideally all of those should be tackled already.
228 Check if the version number is going to remain as, alternatively
229 <code> git mv docs/relnotes/{current,new}.html
</code> as appropriate.
233 To setup the branchpoint:
236 git checkout master # make sure we're in master first
237 git tag -s X.Y-branchpoint -m
"Mesa X.Y branchpoint"
240 $EDITOR VERSION # bump the version number
242 cp docs/relnotes/{X.Y,X.Y+
1}.html # copy/create relnotes template
244 git push origin X.Y-branchpoint X.Y
249 <a href=
"https://bugs.freedesktop.org/editversions.cgi?action=add&product=Mesa" target=
"_parent">Bugzilla
</a> and add the new Mesa version X.Y.
253 Check that there are no distribution breaking changes and revert them if needed.
254 For example: files being overwritten on install, etc. Happens extremely rarely -
255 we had only one case so far (see commit
2ced8eb136528914e1bf4e000dea06a9d53c7e04).
259 Proceed to
<a href=
"#release">release
</a> -rc1.
263 <h1 id=
"prerelease">Pre-release announcement
</h1>
266 It comes shortly after outstanding patches in the respective branch are pushed.
267 Developers can check, in brief, what's the status of their patches. They,
268 alongside very early testers, are strongly encouraged to test the branch and
269 report any regressions.
271 It is followed by a brief period (normally
24 or
48 hours) before the actual
275 <h2>Terminology used
</h2>
277 <ul><li>Nominated
</ul>
280 Patch that is nominated but yet to to merged in the patch queue/branch.
286 Patch is in the queue/branch and will feature in the next release.
287 Barring reported regressions or objections from developers.
290 <ul><li>Rejected
</ul>
293 Patch does not fit the
294 <a href=
"submittingpatches.html#criteria" target=
"_parent">criteria
</a> and
295 is followed by a brief information.
297 The release maintainer is human so if you believe you've spotted a mistake do
301 <h2>Format/template
</h2>
303 Subject: [ANNOUNCE] Mesa X.Y.Z release candidate
304 To: mesa-announce@...
309 The candidate for the Mesa X.Y.Z is now available. Currently we have:
311 - NUMBER nominated (outstanding)
312 - and NUMBER rejected patches
314 BRIEF SUMMARY OF CHANGES
316 Take a look at section
"Mesa stable queue" for more information.
319 Testing reports/general approval
320 --------------------------------
321 Any testing reports (or general approval of the state of the branch) will be
324 The plan is to have X.Y.Z this DAY (DATE), around or shortly after TIME.
326 If you have any questions or suggestions - be that about the current patch
327 queue or otherwise, please go ahead.
330 Trivial merge conflicts
331 -----------------------
332 List of commits where manual intervention was required.
333 Keep the authors in the CC list.
345 commit
990f395e007c3204639daa34efc3049f350ee819
346 Author: Emil Velikov
<emil.velikov@collabora.com
>
348 anv: automake: cleanup the generated json file during make clean
350 (cherry picked from commit
8df581520a823564be0ab5af7dbb7d501b1c9670)
369 2de85eb radv: fix texturesamples to handle single sample case
384 ralloc: Make sure ralloc() allocations match malloc()'s alignment.
386 ralloc: don't leave out the alignment factor
400 a39ad18 configure.ac: honour LLVM_LIBDIR when linking against LLVM
402 Reason: The patch was reverted shortly after it was merged.
406 <h1 id=
"release">Making a new release
</h1>
409 These are the instructions for making a new Mesa release.
412 <h3>Get latest source files
</h3>
415 Ensure the latest code is available - both in your local master and the
419 <h3>Perform basic testing
</h3>
422 Most of the testing should already be done during the
423 <a href=
"#pickntest">cherry-pick
</a> and
424 <a href=
"#prerelease">pre-announce
</a> stages.
425 So we do a quick 'touch test'
429 <li>make distcheck (you can omit this if you're not using --dist below)
430 <li>scons (from release tarball)
431 <li>the produced binaries work
435 Here is one solution that I've been using.
439 # Set MAKEFLAGS if you haven't already
440 git clean -fXd; git clean -nxd
441 read # quick cross check any outstanding files
442 export __version=`cat VERSION`
443 export __mesa_root=../
444 export __build_root=./foo
445 chmod
755 -fR $__build_root; rm -rf $__build_root
446 mkdir -p $__build_root
&& cd $__build_root
448 # For the native builds - such as distcheck, scons, sanity test, you
449 # may want to specify which LLVM to use:
450 # export LLVM_CONFIG=/usr/lib/llvm-
3.9/bin/llvm-config
452 # Do a full distcheck
453 $__mesa_root/autogen.sh
&& make distcheck
455 # Build check the tarballs (scons, linux)
456 tar -xaf mesa-$__version.tar.xz
&& cd mesa-$__version
458 cd ..
&& rm -rf mesa-$__version
460 # Build check the tarballs (scons, windows/mingw)
461 # Temporary drop LLVM_CONFIG, unless you have a Windows/mingw one.
462 # save_LLVM_CONFIG=`echo $LLVM_CONFIG`; unset LLVM_CONFIG
463 tar -xaf mesa-$__version.tar.xz
&& cd mesa-$__version
464 scons platform=windows toolchain=crossmingw
465 cd ..
&& rm -rf mesa-$__version
467 # Test the automake binaries
468 tar -xaf mesa-$__version.tar.xz
&& cd mesa-$__version
469 # Restore LLVM_CONFIG, if applicable:
470 # export LLVM_CONFIG=`echo $save_LLVM_CONFIG`; unset save_LLVM_CONFIG
472 --with-dri-drivers=i965,swrast \
473 --with-gallium-drivers=swrast \
474 --with-vulkan-drivers=intel \
475 --enable-llvm-shared-libs \
480 --with-platforms=x11,drm,wayland,surfaceless
481 make
&& DESTDIR=`pwd`/test make install
483 # Drop LLVM_CONFIG, if applicable:
486 __glxinfo_cmd='glxinfo
2>&1 | egrep -o
"Mesa.*|Gallium.*|.*dri\.so"'
487 __glxgears_cmd='glxgears
2>&1 | grep -v
"configuration file"'
488 __es2info_cmd='es2_info
2>&1 | egrep
"GL_VERSION|GL_RENDERER|.*dri\.so"'
489 __es2gears_cmd='es2gears_x11
2>&1 | grep -v
"configuration file"'
490 test
"x$LD_LIBRARY_PATH" != 'x'
&& __old_ld=
"$LD_LIBRARY_PATH"
491 export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/:
"${__old_ld}"
492 export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
493 export LIBGL_DEBUG=verbose
498 export LIBGL_ALWAYS_SOFTWARE=true
503 export LIBGL_ALWAYS_SOFTWARE=true
504 export GALLIUM_DRIVER=softpipe
510 unset LD_LIBRARY_PATH
511 test
"x$__old_ld" != 'x'
&& export
LD_LIBRARY_PATH=
"$__old_ld" && unset __old_ld
512 unset LIBGL_DRIVERS_PATH
514 unset LIBGL_ALWAYS_SOFTWARE
516 export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
517 steam steam://rungameid/
570 -vconsole -vulkan
518 unset VK_ICD_FILENAMES
521 <h3>Update version in file VERSION
</h3>
524 Increment the version contained in the file VERSION at Mesa's top-level, then
528 <h3>Create release notes for the new release
</h3>
531 Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
532 release notes). Note that the sha256sums section of the release notes should
533 be empty (TBD) at this point.
537 Two scripts are available to help generate portions of the release notes:
541 ./bin/bugzilla_mesa.sh
542 ./bin/shortlog_mesa.sh
546 The first script identifies commits that reference bugzilla bugs and obtains
547 the descriptions of those bugs from bugzilla. The second script generates a
548 log of all commits. In both cases, HTML-formatted lists are printed to stdout
549 to be included in the release notes.
553 Commit these changes and push the branch.
561 <h3>Use the release.sh script from xorg
<a href=
"https://cgit.freedesktop.org/xorg/util/modular/">util-modular
</a></h3>
564 Start the release process.
568 # For the dist/distcheck, you may want to specify which LLVM to use:
569 # export LLVM_CONFIG=/usr/lib/llvm-
3.9/bin/llvm-config
570 ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
574 Pay close attention to the prompts as you might be required to enter your GPG
575 and SSH passphrase(s) to sign and upload the files, respectively.
578 <h3>Add the sha256sums to the release notes
</h3>
581 Edit docs/relnotes/X.Y.Z.html to add the sha256sums as available in the mesa-X.Y.Z.announce template. Commit this change.
584 <h3>Back on mesa master, add the new release notes into the tree
</h3>
587 Something like the following steps will do the trick:
591 git cherry-pick -x X.Y~
1
592 git cherry-pick -x X.Y
596 Also, edit docs/relnotes.html to add a link to the new release notes,
597 edit docs/index.html to add a news entry, and remove the version from
598 docs/release-calendar.html. Then commit and push:
602 git commit -as -m
"docs: update calendar, add news item and link release notes for X.Y.Z"
603 git push origin master X.Y
607 <h1 id=
"announce">Announce the release
</h1>
610 Use the generated template during the releasing process.
614 <h1 id=
"website">Update the mesa3d.org website
</h1>
617 As the hosting was moved to freedesktop, git hooks are deployed to update the
618 website. Manually check that it is updated
5-
10 minutes after the final
<code>git push
</code>
622 <h1 id=
"bugzilla">Update Bugzilla
</h1>
625 Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
628 If there's outstanding action, close the bug referencing the commit ID which
629 addresses the bug and mention the Mesa version that has the fix.
633 Note: the above is not applicable to all the reports, so use common sense.