docs: Mark GLX_ARB_context_flush_control done
[mesa.git] / docs / releasing.html
index 15df022e5f69980ac6fff22c4eda8f83f32b201c..66742b0bcb4bd4bc52614d9c442a64e1c8017238 100644 (file)
@@ -14,6 +14,7 @@
 <iframe src="contents.html"></iframe>
 <div class="content">
 
+
 <h1>Releasing process</h1>
 
 <ul>
@@ -28,6 +29,7 @@
 <li><a href="#bugzilla">Update Bugzilla</a>
 </ul>
 
+
 <h1 id="overview">Overview</h1>
 
 <p>
@@ -48,6 +50,7 @@ For example:
        Mesa 12.0.2 - 12.0 branch, bugfix
 </pre>
 
+
 <h1 id="schedule">Release schedule</h1>
 
 <p>
@@ -82,15 +85,24 @@ The final release from the 12.0 series Mesa 12.0.5 will be out around the same
 time (or shortly after) 13.0.1 is out.
 </p>
 
+
 <h1 id="pickntest">Cherry-picking and testing</h1>
 
 <p>
 Commits nominated for the active branch are picked as based on the
 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
 described in the same section.
+</p>
 
 <p>
-Maintainer is responsible for testing in various possible permutations of
+Nomination happens in the mesa-stable@ mailing list. However,
+maintainer is resposible of checking for forgotten candidates in the
+master branch. This is achieved by a combination of ad-hoc scripts and
+a casual search for terms such as regression, fix, broken and similar.
+</p>
+
+<p>
+Maintainer is also responsible for testing in various possible permutations of
 the autoconf and scons build.
 </p>
 
@@ -104,33 +116,57 @@ release. This is made <strong>only</strong> with explicit permission/request,
 and the patch <strong>must</strong> be very well contained. Thus it cannot
 affect more than one driver/subsystem.
 </p>
+
 <p>
 Currently Ilia Mirkin and AMD devs have requested "permanent" exception.
 </p>
 
-
 <ul>
 <li>make distcheck, scons and scons check must pass
 <li>Testing with different version of system components - LLVM and others is also
 performed where possible.
+<li>As a general rule, testing with various combinations of configure
+switches, depending on the specific patchset.
 </ul>
+
 <p>
-Achieved by combination of local ad-hoc scripts and AppVeyor plus Travis-CI,
-the latter as part of their Github integration.
+Achieved by combination of local ad-hoc scripts, mingw-w64 cross
+compilation and AppVeyor plus Travis-CI, the latter as part of their
+Github integration.
 </p>
+
+<p>
+For Windows related changes, the main contact point is Brian
+Paul. Jose Fonseca can also help as a fallback contact.
+</p>
+
+<p>
+For Android related changes, the main contact is Tapani
+P&auml;lli. Mauro Rossi is collaborating with android-x86 and may
+provide feedback about the build status in that project.
+</p>
+
+<p>
+For MacOSX related changes, Jeremy Huddleston Sequoia is currently a
+good contact point.
+</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.
+</p>
+
 <pre>
     git show b10859ec41d09c57663a258f43fe57c12332698e
 
     commit b10859ec41d09c57663a258f43fe57c12332698e
-    Author: Jonas Pfeil &ltpfeiljonas@gmx.de&gt
+    Author: Jonas Pfeil &lt;pfeiljonas@gmx.de&gt;
     Date:   Wed Mar 1 18:11:10 2017 +0100
 
         ralloc: Make sure ralloc() allocations match malloc()'s alignment.
@@ -149,7 +185,6 @@ This should be noted in the <a href="#prerelease">pre-announce</a> email.
 
         (cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
 </pre>
-</p>
 
 <h2>Regression/functionality testing</h2>
 
@@ -157,15 +192,23 @@ This should be noted in the <a href="#prerelease">pre-announce</a> email.
 Less often (once or twice), shortly before the pre-release announcement.
 Ensure that testing is redone if Intel devs have requested an exception, as per above.
 </p>
+
 <ul>
 <li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms</em>
 <li><em>no regressions should be observed for Piglit using the swrast, softpipe
 and llvmpipe drivers</em>
 </ul>
+
 <p>
 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.
 </p>
 
+<p>
+Installing the built driver from the pre-announced RC branch in the
+system and making some every day's use until the release may be a good
+idea too.
+</p>
+
 
 <h1 id="branch">Making a branchpoint</h1>
 
@@ -205,15 +248,18 @@ To setup the branchpoint:
 Now go to
 <a href="https://bugs.freedesktop.org/editversions.cgi?action=add&amp;product=Mesa" target="_parent">Bugzilla</a> and add the new Mesa version X.Y.
 </p>
+
 <p>
 Check that there are no distribution breaking changes and revert them if needed.
 For example: files being overwritten on install, etc. Happens extremely rarely -
 we had only one case so far (see commit 2ced8eb136528914e1bf4e000dea06a9d53c7e04).
 </p>
+
 <p>
 Proceed to <a href="#release">release</a> -rc1.
 </p>
 
+
 <h1 id="prerelease">Pre-release announcement</h1>
 
 <p>
@@ -227,18 +273,22 @@ release is made.
 </p>
 
 <h2>Terminology used</h2>
+
 <ul><li>Nominated</ul>
+
 <p>
 Patch that is nominated but yet to to merged in the patch queue/branch.
 </p>
 
 <ul><li>Queued</ul>
+
 <p>
 Patch is in the queue/branch and will feature in the next release.
 Barring reported regressions or objections from developers.
 </p>
 
 <ul><li>Rejected</ul>
+
 <p>
 Patch does not fit the
 <a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
@@ -344,6 +394,7 @@ AUTHOR (NUMBER):
 Reason: ...
 </pre>
 
+
 <h1 id="release">Making a new release</h1>
 
 <p>
@@ -351,18 +402,21 @@ These are the instructions for making a new Mesa release.
 </p>
 
 <h3>Get latest source files</h3>
+
 <p>
 Ensure the latest code is available - both in your local master and the
 relevant branch.
 </p>
 
 <h3>Perform basic testing</h3>
+
 <p>
 Most of the testing should already be done during the
 <a href="#pickntest">cherry-pick</a> and
 <a href="#prerelease">pre-announce</a> stages.
-
 So we do a quick 'touch test'
+</p>
+
 <ul>
 <li>make distcheck (you can omit this if you're not using --dist below)
 <li>scons (from release tarball)
@@ -374,6 +428,7 @@ Here is one solution that I've been using.
 </p>
 
 <pre>
+       # Set MAKEFLAGS if you haven't already
        git clean -fXd; git clean -nxd
        read # quick cross check any outstanding files
        export __version=`cat VERSION`
@@ -382,7 +437,12 @@ Here is one solution that I've been using.
        chmod 755 -fR $__build_root; rm -rf $__build_root
        mkdir -p $__build_root &amp;&amp; cd $__build_root
 
-       $__mesa_root/autogen.sh &amp;&amp; make -j2 distcheck
+       # For the native builds - such as distcheck, scons, sanity test, you
+       # may want to specify which LLVM to use:
+       # export LLVM_CONFIG=/usr/lib/llvm-3.9/bin/llvm-config
+
+       # Do a full distcheck
+       $__mesa_root/autogen.sh &amp;&amp; make distcheck
 
        # Build check the tarballs (scons, linux)
        tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
@@ -390,12 +450,16 @@ Here is one solution that I've been using.
        cd .. &amp;&amp; rm -rf mesa-$__version
 
        # Build check the tarballs (scons, windows/mingw)
+       # Temporary drop LLVM_CONFIG, unless you have a Windows/mingw one.
+       # save_LLVM_CONFIG=`echo $LLVM_CONFIG`; unset LLVM_CONFIG
        tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
        scons platform=windows toolchain=crossmingw
        cd .. &amp;&amp; rm -rf mesa-$__version
 
        # Test the automake binaries
        tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
+       # Restore LLVM_CONFIG, if applicable:
+       # export LLVM_CONFIG=`echo $save_LLVM_CONFIG`; unset save_LLVM_CONFIG
        ./configure \
                --with-dri-drivers=i965,swrast \
                --with-gallium-drivers=swrast \
@@ -405,25 +469,26 @@ Here is one solution that I've been using.
                --enable-glx-tls \
                --enable-gbm \
                --enable-egl \
-               --with-egl-platforms=x11,drm,wayland
-       make -j2 &amp;&amp; DESTDIR=`pwd`/test make -j6 install
+               --with-platforms=x11,drm,wayland,surfaceless
+       make &amp;&amp; DESTDIR=`pwd`/test make install
        __glxinfo_cmd='glxinfo 2>&amp;1 | egrep -o "Mesa.*|Gallium.*|.*dri\.so"'
        __glxgears_cmd='glxgears 2>&amp;1 | grep -v "configuration file"'
        __es2info_cmd='es2_info 2>&amp;1 | egrep "GL_VERSION|GL_RENDERER|.*dri\.so"'
        __es2gears_cmd='es2gears_x11 2>&amp;1 | grep -v "configuration file"'
-       export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/
+       test "x$LD_LIBRARY_PATH" != 'x' &amp;&amp; __old_ld="$LD_LIBRARY_PATH"
+       export LD_LIBRARY_PATH=`pwd`/test/usr/local/lib/:"${__old_ld}"
        export LIBGL_DRIVERS_PATH=`pwd`/test/usr/local/lib/dri/
        export LIBGL_DEBUG=verbose
        eval $__glxinfo_cmd
        eval $__glxgears_cmd
        eval $__es2info_cmd
        eval $__es2gears_cmd
-       export LIBGL_ALWAYS_SOFTWARE=1
+       export LIBGL_ALWAYS_SOFTWARE=true
        eval $__glxinfo_cmd
        eval $__glxgears_cmd
        eval $__es2info_cmd
        eval $__es2gears_cmd
-       export LIBGL_ALWAYS_SOFTWARE=1
+       export LIBGL_ALWAYS_SOFTWARE=true
        export GALLIUM_DRIVER=softpipe
        eval $__glxinfo_cmd
        eval $__glxgears_cmd
@@ -431,6 +496,7 @@ Here is one solution that I've been using.
        eval $__es2gears_cmd
        # Smoke test DOTA2
        unset LD_LIBRARY_PATH
+       test "x$__old_ld" != 'x' &amp;&amp; export LD_LIBRARY_PATH="$__old_ld" &amp;&amp; unset __old_ld
        unset LIBGL_DRIVERS_PATH
        unset LIBGL_DEBUG
        unset LIBGL_ALWAYS_SOFTWARE
@@ -455,6 +521,7 @@ be empty (TBD) at this point.
 
 <p>
 Two scripts are available to help generate portions of the release notes:
+</p>
 
 <pre>
        ./bin/bugzilla_mesa.sh
@@ -471,6 +538,7 @@ to be included in the release notes.
 <p>
 Commit these changes and push the branch.
 </p>
+
 <pre>
        git push origin HEAD
 </pre>
@@ -481,7 +549,10 @@ Commit these changes and push the branch.
 <p>
 Start the release process.
 </p>
+
 <pre>
+       # For the dist/distcheck, you may want to specify which LLVM to use:
+       # export LLVM_CONFIG=/usr/lib/llvm-3.9/bin/llvm-config
        ../relative/path/to/release.sh . # append --dist if you've already done distcheck above
 </pre>
 
@@ -508,17 +579,19 @@ Something like the following steps will do the trick:
 </pre>
 
 <p>
-Also, edit docs/relnotes.html to add a link to the new release notes, and edit
-docs/index.html to add a news entry. Then commit and push:
+Also, edit docs/relnotes.html to add a link to the new release notes,
+edit docs/index.html to add a news entry, and remove the version from
+docs/release-calendar.html. Then commit and push:
 </p>
 
 <pre>
-       git commit -as -m "docs: add news item and link release notes for X.Y.Z"
+       git commit -as -m "docs: update calendar, add news item and link release notes for X.Y.Z"
        git push origin master X.Y
 </pre>
 
 
 <h1 id="announce">Announce the release</h1>
+
 <p>
 Use the generated template during the releasing process.
 </p>
@@ -531,6 +604,7 @@ As the hosting was moved to freedesktop, git hooks are deployed to update the
 website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
 </p>
 
+
 <h1 id="bugzilla">Update Bugzilla</h1>
 
 <p>