diff options
| -rw-r--r-- | docs/conform.rst | 2 | ||||
| -rw-r--r-- | docs/envvars.rst | 13 | ||||
| -rw-r--r-- | docs/index.rst | 169 | ||||
| -rw-r--r-- | docs/install.rst | 6 | ||||
| -rw-r--r-- | docs/lists.rst | 12 | ||||
| -rw-r--r-- | docs/meson.rst | 12 | ||||
| -rw-r--r-- | docs/releasing.rst | 39 | ||||
| -rw-r--r-- | docs/relnotes/7.10.2.rst | 2 | ||||
| -rw-r--r-- | docs/relnotes/7.5.rst | 11 | ||||
| -rw-r--r-- | docs/submittingpatches.rst | 22 | ||||
| -rw-r--r-- | docs/versions.rst | 12 | ||||
| -rw-r--r-- | docs/vmware-guest.rst | 22 |
12 files changed, 197 insertions, 125 deletions
diff --git a/docs/conform.rst b/docs/conform.rst index 219d0a496b8..4d23dadd1a9 100644 --- a/docs/conform.rst +++ b/docs/conform.rst @@ -672,4 +672,4 @@ upon Mesa. Conformx passed. -NOTE: conformx passes for all machine path levels (-p option). +.. note:: conformx passes for all machine path levels (-p option). diff --git a/docs/envvars.rst b/docs/envvars.rst index 59060cf400a..4ba39d9b073 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -147,10 +147,15 @@ Core Mesa environment variables GLSL programs. Should be set to a number optionally followed by ``K``, ``M``, or ``G`` to specify a size in kilobytes, megabytes, or gigabytes. By default, gigabytes will be assumed. And if unset, a - maximum size of 1GB will be used. Note: A separate cache might be - created for each architecture that Mesa is installed for on your - system. For example under the default settings you may end up with a - 1GB cache for x86_64 and another 1GB cache for i386. + maximum size of 1GB will be used. + + .. note:: + + A separate cache might be created for each architecture that Mesa is + installed for on your system. For example under the default settings + you may end up with a 1GB cache for x86_64 and another 1GB cache for + i386. + ``MESA_GLSL_CACHE_DIR`` if set, determines the directory to be used for the on-disk cache of compiled GLSL programs. If this variable is not set, then the cache diff --git a/docs/index.rst b/docs/index.rst index c53b64305dd..09107bfb85a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -165,9 +165,11 @@ October 21, 2019 `Mesa 19.1.8 <relnotes/19.1.8.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 19.1.8 will be the final release in the -19.1 series. Users of 19.1 are encouraged to migrate to the 19.2 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 19.1.8 will be the final release in the + 19.1 series. Users of 19.1 are encouraged to migrate to the 19.2 series + in order to obtain future fixes. October 9, 2019 --------------- @@ -237,9 +239,11 @@ June 24, 2019 `Mesa 19.0.7 <relnotes/19.0.7.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 19.0.7 will be the final release in the -19.0 series. Users of 19.0 are encouraged to migrate to the 19.1 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 19.0.7 will be the final release in the + 19.0 series. Users of 19.0 are encouraged to migrate to the 19.1 series + in order to obtain future fixes. June 11, 2019 ------------- @@ -284,9 +288,11 @@ April 5, 2019 `Mesa 18.3.6 <relnotes/18.3.6.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 18.3.6 will be the final release in the -18.3 series. Users of 18.3 are encouraged to migrate to the 19.0 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 18.3.6 will be the final release in the + 18.3 series. Users of 18.3 are encouraged to migrate to the 19.0 series + in order to obtain future fixes. March 27, 2019 -------------- @@ -331,9 +337,11 @@ December 27, 2018 `Mesa 18.2.8 <relnotes/18.2.8.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 18.2.8 will be the final release in the -18.2 series. Users of 18.2 are encouraged to migrate to the 18.3 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 18.2.8 will be the final release in the + 18.2 series. Users of 18.2 are encouraged to migrate to the 18.3 series + in order to obtain future fixes. December 13, 2018 ----------------- @@ -390,9 +398,11 @@ September 24, 2018 `Mesa 18.1.9 <relnotes/18.1.9.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 18.1.9 will be the final release in the -18.1 series. Users of 18.1 are encouraged to migrate to the 18.2 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 18.1.9 will be the final release in the + 18.1 series. Users of 18.1 are encouraged to migrate to the 18.2 series + in order to obtain future fixes. September 21, 2018 ------------------ @@ -450,9 +460,11 @@ June 3, 2018 `Mesa 18.0.5 <relnotes/18.0.5.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 18.0.5 will be the final release in the -18.0 series. Users of 18.0 are encouraged to migrate to the 18.1 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 18.0.5 will be the final release in the + 18.0 series. Users of 18.0 are encouraged to migrate to the 18.1 series + in order to obtain future fixes. June 1, 2018 ------------ @@ -499,9 +511,11 @@ April 18, 2018 `Mesa 17.3.9 <relnotes/17.3.9.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 17.3.9 will be the final release in the -17.3 series. Users of 17.3 are encouraged to migrate to the 18.0 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 17.3.9 will be the final release in the + 17.3 series. Users of 17.3 are encouraged to migrate to the 18.0 series + in order to obtain future fixes. April 03, 2018 -------------- @@ -558,9 +572,11 @@ December 22, 2017 `Mesa 17.2.8 <relnotes/17.2.8.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 17.2.8 will be the final release in the -17.2 series. Users of 17.2 are encouraged to migrate to the 17.3 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 17.2.8 will be the final release in the + 17.2 series. Users of 17.2 are encouraged to migrate to the 17.3 series + in order to obtain future fixes. December 21, 2017 ----------------- @@ -617,9 +633,11 @@ September 25, 2017 `Mesa 17.1.10 <relnotes/17.1.10.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 17.1.10 will be the final release in the -17.1 series. Users of 17.1 are encouraged to migrate to the 17.2 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 17.1.10 will be the final release in the + 17.1 series. Users of 17.1 are encouraged to migrate to the 17.2 series + in order to obtain future fixes. September 17, 2017 ------------------ @@ -688,9 +706,11 @@ June 1, 2017 `Mesa 17.0.7 <relnotes/17.0.7.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 17.0.7 will be the final release in the -17.0 series. Users of 17.0 are encouraged to migrate to the 17.1 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 17.0.7 will be the final release in the + 17.0 series. Users of 17.0 are encouraged to migrate to the 17.1 series + in order to obtain future fixes. May 25, 2017 ------------ @@ -736,9 +756,11 @@ March 20, 2017 17.0.2 <relnotes/17.0.2.html>`__ are released. These are bug-fix releases from the 13.0 and 17.0 branches, respectively. -NOTE: It is anticipated that 13.0.6 will be the final release in the -13.0 series. Users of 13.0 are encouraged to migrate to the 17.0 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 13.0.6 will be the final release in the + 13.0 series. Users of 13.0 are encouraged to migrate to the 17.0 series + in order to obtain future fixes. March 4, 2017 ------------- @@ -771,10 +793,12 @@ January 23, 2017 `Mesa 12.0.6 <relnotes/12.0.6.html>`__ is released. This is a bug-fix release. -NOTE: This is an extra release for the 12.0 stable branch, as per -developers' feedback. It is anticipated that 12.0.6 will be the final -release in the 12.0 series. Users of 12.0 are encouraged to migrate to -the 13.0 series in order to obtain future fixes. +.. note:: + + This is an extra release for the 12.0 stable branch, as per + developers' feedback. It is anticipated that 12.0.6 will be the final + release in the 12.0 series. Users of 12.0 are encouraged to migrate to + the 13.0 series in order to obtain future fixes. January 5, 2017 --------------- @@ -788,9 +812,11 @@ December 5, 2016 `Mesa 12.0.5 <relnotes/12.0.5.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 12.0.5 will be the final release in the -12.0 series. Users of 12.0 are encouraged to migrate to the 13.0 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 12.0.5 will be the final release in the + 12.0 series. Users of 12.0 are encouraged to migrate to the 13.0 series + in order to obtain future fixes. November 28, 2016 ----------------- @@ -846,9 +872,11 @@ May 9, 2016 11.2.2 <relnotes/11.2.2.html>`__ are released. These are bug-fix releases from the 11.1 and 11.2 branches, respectively. -NOTE: It is anticipated that 11.1.4 will be the final release in the -11.1.4 series. Users of 11.1 are encouraged to migrate to the 11.2 -series in order to obtain future fixes. +.. note:: + + It is anticipated that 11.1.4 will be the final release in the + 11.1.4 series. Users of 11.1 are encouraged to migrate to the 11.2 + series in order to obtain future fixes. April 17, 2016 -------------- @@ -876,9 +904,11 @@ January 22, 2016 `Mesa 11.0.9 <relnotes/11.0.9.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 11.0.9 will be the final release in the -11.0 series. Users of 11.0 are encouraged to migrate to the 11.1 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 11.0.9 will be the final release in the + 11.0 series. Users of 11.0 are encouraged to migrate to the 11.1 series + in order to obtain future fixes. January 13, 2016 ---------------- @@ -940,9 +970,11 @@ October 3, 2015 `Mesa 10.6.9 <relnotes/10.6.9.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 10.6.9 will be the final release in the -10.6 series. Users of 10.6 are encouraged to migrate to the 11.0 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 10.6.9 will be the final release in the + 10.6 series. Users of 10.6 are encouraged to migrate to the 11.0 series + in order to obtain future fixes. September 28, 2015 ------------------ @@ -1011,9 +1043,11 @@ July 04, 2015 `Mesa 10.5.9 <relnotes/10.5.9.html>`__ is released. This is a bug-fix release. -NOTE: It is anticipated that 10.5.9 will be the final release in the -10.5 series. Users of 10.5 are encouraged to migrate to the 10.6 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 10.5.9 will be the final release in the + 10.5 series. Users of 10.5 are encouraged to migrate to the 10.6 series + in order to obtain future fixes. June 29, 2015 ------------- @@ -1122,9 +1156,11 @@ January 12, 2015 10.4.2 <relnotes/10.4.2.html>`__ are released. These are bug-fix releases from the 10.3 and 10.4 branches, respectively. -NOTE: It is anticipated that 10.3.7 will be the final release in the -10.3 series. Users of 10.3 are encouraged to migrate to the 10.4 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 10.3.7 will be the final release in the + 10.3 series. Users of 10.3 are encouraged to migrate to the 10.4 series + in order to obtain future fixes. December 29, 2014 ----------------- @@ -1171,9 +1207,11 @@ October 12, 2014 10.3.1 <relnotes/10.3.1.html>`__ are released. These are bug-fix releases from the 10.2 and 10.3 branches, respectively. -NOTE: It is anticipated that 10.2.9 will be the final release in the -10.2 series. Users of 10.2 are encouraged to migrate to the 10.3 series -in order to obtain future fixes. +.. note:: + + It is anticipated that 10.2.9 will be the final release in the + 10.2 series. Users of 10.2 are encouraged to migrate to the 10.3 series + in order to obtain future fixes. September 19, 2014 ------------------ @@ -1283,10 +1321,12 @@ April 18, 2014 `Mesa 10.0.5 <relnotes/10.0.5.html>`__ is released. This is a bug-fix release. -NOTE: Since the 10.1.1 release is being released concurrently, it is -anticipated that 10.0.5 will be the final release in the 10.0 series. -Users of 10.0 are encouraged to migrate to the 10.1 series in order to -obtain future fixes. +.. note:: + + Since the 10.1.1 release is being released concurrently, it is + anticipated that 10.0.5 will be the final release in the 10.0 series. + Users of 10.0 are encouraged to migrate to the 10.1 series in order to + obtain future fixes. March 12, 2014 -------------- @@ -1739,8 +1779,9 @@ bug-fix release. August 19, 2005 --------------- -Mesa 6.3.2 has been released. Note: there was no public release of -version 6.3.1. +Mesa 6.3.2 has been released. + +.. note:: there was no public release of version 6.3.1. `Changes in version 6.3.1 <versions.html#6.3.2>`__ diff --git a/docs/install.rst b/docs/install.rst index d5a1929c457..3aa7954fe90 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -68,8 +68,10 @@ Third party/extra tools. For MSVC on Windows, install `Win flex-bison <http://winflexbison.sourceforge.net/>`__. -**Note**: Some versions can be buggy (eg. flex 2.6.2) so do try others -if things fail. +.. note:: + + Some versions can be buggy (eg. flex 2.6.2) so do try others + if things fail. .. _prereq-dri: diff --git a/docs/lists.rst b/docs/lists.rst index dd0180393f4..4a98ac0958b 100644 --- a/docs/lists.rst +++ b/docs/lists.rst @@ -23,11 +23,13 @@ There are four Mesa 3D / DRI mailing lists: - `piglit <https://lists.freedesktop.org/mailman/listinfo/piglit>`__ - for Piglit (OpenGL driver testing framework) discussion. -**NOTE**: You **must** subscribe to these lists in order to post to -them. If you try to post to a list and you're not a subscriber (or if -you try to post from a different email address than you subscribed with) -your posting will be held for an indefinite period or may be discarded -entirely. +.. note:: + + You **must** subscribe to these lists in order to post to + them. If you try to post to a list and you're not a subscriber (or if + you try to post from a different email address than you subscribed with) + your posting will be held for an indefinite period or may be discarded + entirely. Follow the links above for list archives. diff --git a/docs/meson.rst b/docs/meson.rst index dd709b16f4a..0b60b881902 100644 --- a/docs/meson.rst +++ b/docs/meson.rst @@ -143,13 +143,15 @@ symbolic links for drivers). To install: ninja -C build/ install -Note: autotools automatically updated translation files (used by the DRI -configuration tool) as part of the build process, Meson does not do -this. Instead, you will need do this: +.. note:: -:: + autotools automatically updated translation files (used by the DRI + configuration tool) as part of the build process, Meson does not do + this. Instead, you will need do this: + + :: - ninja -C build/ xmlpool-pot xmlpool-update-po xmlpool-gmo + ninja -C build/ xmlpool-pot xmlpool-update-po xmlpool-gmo Windows specific instructions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/releasing.rst b/docs/releasing.rst index be5713eca23..7a9654ac8e2 100644 --- a/docs/releasing.rst +++ b/docs/releasing.rst @@ -56,17 +56,19 @@ Stable releases - Normally available once every two weeks. - Only the latest branch has releases. See note below. -Note: There is one or two releases overlap when changing branches. For -example: +.. note:: -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. + There is one or two releases overlap when changing branches. For + example: -This also involves that, as a final release may be delayed due to the -need of additional candidates to solve some blocking regression(s), the -release manager might have to update the -`calendar <release-calendar.html>`__ with additional bug fix releases of -the current stable branch. + 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. + + This also involves that, as a final release may be delayed due to the + need of additional candidates to solve some blocking regression(s), the + release manager might have to update the + `calendar <release-calendar.html>`__ with additional bug fix releases of + the current stable branch. .. _pickntest: @@ -111,9 +113,11 @@ the build status in that project. For MacOSX related changes, Jeremy Huddleston Sequoia is currently a good contact point. -**Note:** If a patch in the current queue needs any additional fix(es), -then they should be squashed together. The commit messages and the -"``cherry picked from``"-tags must be preserved. +.. note:: + + If a patch in the current queue needs any additional fix(es), + then they should be squashed together. The commit messages and the + "``cherry picked from``"-tags must be preserved. :: @@ -174,9 +178,11 @@ Making a branchpoint A branchpoint is made such that new development can continue in parallel to stabilisation and bugfixing. -Note: Before doing a branch ensure that basic build and ``meson test`` -testing is done and there are little to-no issues. Ideally all of those -should be tackled already. +.. note:: + + Before doing a branch ensure that basic build and ``meson test`` + testing is done and there are little to-no issues. Ideally all of those + should be tackled already. Check if the version number is going to remain as, alternatively ``git mv docs/relnotes/{current,new}.html`` as appropriate. @@ -347,5 +353,4 @@ document. If there's outstanding action, close the bug referencing the commit ID which addresses the bug and mention the Mesa version that has the fix. -Note: the above is not applicable to all the reports, so use common -sense. +.. note: the above is not applicable to all the reports, so use common sense. diff --git a/docs/relnotes/7.10.2.rst b/docs/relnotes/7.10.2.rst index 70db062147d..56a0c11bd03 100644 --- a/docs/relnotes/7.10.2.rst +++ b/docs/relnotes/7.10.2.rst @@ -70,7 +70,7 @@ command: git log mesa-7.10.1..mesa-7.10.2 -*Note:* Reverted commits and the reverts are not included in this list. +.. note:: Reverted commits and the reverts are not included in this list. Alex Deucher (2): diff --git a/docs/relnotes/7.5.rst b/docs/relnotes/7.5.rst index 03db1acca91..5268bacd9b7 100644 --- a/docs/relnotes/7.5.rst +++ b/docs/relnotes/7.5.rst @@ -48,10 +48,13 @@ New features - softpipe - a software/reference driver - i915 - Intel 915/945 driver - Cell - IBM/Sony/Toshiba Cell processor driver - - nouveau (for NVIDIA GPUs) and R300 for (AMD/ATI R300). **PLEASE - NOTE: these drivers are incomplete and still under development. - It's probably NOT worthwhile to report any bugs unless you have - patches.** + - nouveau (for NVIDIA GPUs) and R300 for (AMD/ATI R300). + + .. note:: + + these drivers are incomplete and still under development. + It's probably NOT worthwhile to report any bugs unless you have + patches. - GL_ARB_framebuffer_object extension (software drivers, i965 driver) - Reworked two-sided stencil support. This allows a driver to support diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 7b25f0eecf5..c99e8d0b012 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -323,17 +323,23 @@ broad discretion in rejecting patches that have been nominated. patch is too large and/or otherwise contradicts with the rules set within, a backport is appropriate. - It must not introduce a regression - be that build or runtime wise. - Note: If the regression is due to faulty piglit/dEQP/CTS/other test - the latter must be fixed first. A reference to the offending test(s) - and respective fix(es) should be provided in the nominated patch. + + .. note:: + If the regression is due to faulty piglit/dEQP/CTS/other test + the latter must be fixed first. A reference to the offending test(s) + and respective fix(es) should be provided in the nominated patch. + - Patch cannot be larger than 100 lines. - Patches that move code around with no functional change should be rejected. -- Patch must be a bug fix and not a new feature. Note: An exception to - this rule, are hardware-enabling "features". For example, - `backports <#backports>`__ of new code to support a newly-developed - hardware product can be accepted if they can be reasonably determined - not to have effects on other hardware. +- Patch must be a bug fix and not a new feature. + + .. note:: + An exception to this rule, are hardware-enabling "features". For + example, `backports <#backports>`__ of new code to support a + newly-developed hardware product can be accepted if they can be + reasonably determined not to have effects on other hardware. + - Patch must be reviewed, For example, the commit message has Reviewed-by, Signed-off-by, or Tested-by tags from someone but the author. diff --git a/docs/versions.rst b/docs/versions.rst index 59757dab2d7..53ce11f64c4 100644 --- a/docs/versions.rst +++ b/docs/versions.rst @@ -1,8 +1,10 @@ Mesa Version History ==================== -**NOTE: Changes for Mesa 6.4 and later are documented in the -corresponding**\ `release notes <relnotes.html>`__\ **file.** +.. note:: + + Changes for Mesa 6.4 and later are documented in the corresponding + `release notes <relnotes.html>`__ file. 1.0 beta February 1995 ---------------------- @@ -1648,5 +1650,7 @@ Bug fixes: - fixed glxext.h cross-compile issue (Colin Harrison) - assorted DRI driver fixes -**NOTE: Changes for Mesa 6.4 and later are documented in the -corresponding**\ `release notes <relnotes.html>`__\ **file.** +.. note:: + + Changes for Mesa 6.4 and later are documented in the corresponding + `release notes <relnotes.html>`__ file. diff --git a/docs/vmware-guest.rst b/docs/vmware-guest.rst index 88387171b5a..d738f2be74e 100644 --- a/docs/vmware-guest.rst +++ b/docs/vmware-guest.rst @@ -248,20 +248,22 @@ Building the Code echo vmwgfx | sudo tee -a /etc/modules - Note: some distros put DRM kernel drivers in different directories. - For example, sometimes vmwgfx.ko might be found in - ``/lib/modules/{version}/extra/vmwgfx.ko`` or in - ``/lib/modules/{version}/kernel/drivers/gpu/drm/vmwgfx/vmwgfx.ko``. + .. note:: - After installing vmwgfx.ko you might want to run the following - command to check that the new kernel module is in the expected place: + some distros put DRM kernel drivers in different directories. + For example, sometimes vmwgfx.ko might be found in + ``/lib/modules/{version}/extra/vmwgfx.ko`` or in + ``/lib/modules/{version}/kernel/drivers/gpu/drm/vmwgfx/vmwgfx.ko``. - :: + After installing vmwgfx.ko you might want to run the following + command to check that the new kernel module is in the expected place: + + :: - find /lib/modules -name vmwgfx.ko -exec ls -l '{}' \; + find /lib/modules -name vmwgfx.ko -exec ls -l '{}' \; - If you see the kernel module listed in more than one place, you may - need to move things around. + If you see the kernel module listed in more than one place, you may + need to move things around. Finally, if you update your kernel you'll probably have to rebuild and reinstall the vmwgfx.ko module again. |