x11/dri3: Don't open-code ARRAY_SIZE

[mesa.git] / docs / releasing.html

diff --git a/docs/releasing.html b/docs/releasing.html
index 0af05af31ae42658238281d7c95b8e8883cb966b..a022d0c484bc0f635b6120e363392c63c2b327b2 100644 (file)
--- a/docs/releasing.html
+++ b/docs/releasing.html
@@ -96,7 +96,7 @@ described in the same section.
 
 <p>
 Nomination happens in the mesa-stable@ mailing list. However,
-maintainer is resposible of checking for forgotten candidates in the
+maintainer is responsible 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>
@@ -272,6 +272,11 @@ It is followed by a brief period (normally 24 or 48 hours) before the actual
 release is made.
 </p>
 
+<p>
+Be aware to add a note to warn about a final release in a series, if
+that is the case.
+</p>
+
 <h2>Terminology used</h2>
 
 <ul><li>Nominated</ul>
@@ -311,6 +316,10 @@ The candidate for the Mesa X.Y.Z is now available. Currently we have:
  - NUMBER nominated (outstanding)
  - and NUMBER rejected patches
 
+[If applicable:
+Note: this is the final anticipated release in the SERIES series. Users are
+encouraged to migrate to the NEXT_SERIES series in order to obtain future fixes.]
+
 BRIEF SUMMARY OF CHANGES
 
 Take a look at section "Mesa stable queue" for more information.
@@ -374,6 +383,9 @@ Queued (NUMBER)
 
 AUTHOR (NUMBER):
       COMMIT SUMMARY
+[If applicable:
+Squashed with
+      COMMIT SUMMARY]
 
 For example:
 
@@ -382,16 +394,21 @@ Jonas Pfeil (1):
 Squashed with
       ralloc: don't leave out the alignment factor
 
+
 Rejected (NUMBER)
 =================
 
-Rejected (11)
-=============
-
 AUTHOR (NUMBER):
       SHA     COMMIT SUMMARY
 
 Reason: ...
+
+For example:
+
+Emil Velikov (1)
+      a39ad18 configure.ac: honour LLVM_LIBDIR when linking against LLVM
+
+Reason: The patch was reverted shortly after it was merged.
 </pre>
 
 
@@ -428,6 +445,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`
@@ -436,9 +454,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
 
-       # For the distcheck, you may want to specify which LLVM to use:
+       # 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
-       $__mesa_root/autogen.sh &amp;&amp; make -j2 distcheck
+
+       # 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
@@ -446,27 +467,31 @@ Here is one solution that I've been using.
        cd .. &amp;&amp; rm -rf mesa-$__version
 
        # Build check the tarballs (scons, windows/mingw)
-       # You may need to unset LLVM if you set it before:
-       # unset LLVM_CONFIG
+       # 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
+       # Restore LLVM_CONFIG, if applicable:
+       # export LLVM_CONFIG=`echo $save_LLVM_CONFIG`; unset save_LLVM_CONFIG
        tar -xaf mesa-$__version.tar.xz &amp;&amp; cd mesa-$__version
-       # You may want to specify which LLVM to use:
        ./configure \
                --with-dri-drivers=i965,swrast \
                --with-gallium-drivers=swrast \
                --with-vulkan-drivers=intel \
                --enable-llvm-shared-libs \
                --enable-llvm \
-               --with-llvm-prefix=/usr/lib/llvm-3.9 \
                --enable-glx-tls \
                --enable-gbm \
                --enable-egl \
                --with-platforms=x11,drm,wayland,surfaceless
-       make -j2 &amp;&amp; DESTDIR=`pwd`/test make -j6 install
+       make &amp;&amp; DESTDIR=`pwd`/test make install
+
+       # Drop LLVM_CONFIG, if applicable:
+       # unset LLVM_CONFIG
+
        __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"'
@@ -479,12 +504,12 @@ Here is one solution that I've been using.
        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
@@ -496,8 +521,10 @@ Here is one solution that I've been using.
        unset LIBGL_DRIVERS_PATH
        unset LIBGL_DEBUG
        unset LIBGL_ALWAYS_SOFTWARE
+       unset GALLIUM_DRIVER
        export VK_ICD_FILENAMES=`pwd`/src/intel/vulkan/dev_icd.json
        steam steam://rungameid/570  -vconsole -vulkan
+       unset VK_ICD_FILENAMES
 </pre>
 
 <h3>Update version in file VERSION</h3>
@@ -576,7 +603,8 @@ Something like the following steps will do the trick:
 
 <p>
 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
+edit docs/index.html to add a news entry and a note in case of the
+last release in a series, and remove the version from
 docs/release-calendar.html. Then commit and push:
 </p>
 
@@ -592,6 +620,11 @@ docs/release-calendar.html. Then commit and push:
 Use the generated template during the releasing process.
 </p>
 
+<p>
+Again, pay attention to add a note to warn about a final release in a
+series, if that is the case.
+</p>
+
 
 <h1 id="website">Update the mesa3d.org website</h1>