summaryrefslogtreecommitdiff
path: root/docs/amber.rst
diff options
context:
space:
mode:
authorErik Faye-Lund <erik.faye-lund@collabora.com>2022-09-18 11:36:55 +0200
committerMarge Bot <emma+marge@anholt.net>2022-09-23 10:49:08 +0000
commit88ed8245a8cf3e902b2b11ade8adfe7ac623d159 (patch)
tree18cb92aa1ef77da006955488327e8f4207068f6d /docs/amber.rst
parenteded5bda4ef1fe5fa90d794b3ed79312bbab58cf (diff)
downloadmesa-88ed8245a8cf3e902b2b11ade8adfe7ac623d159.tar.gz
docs: add an amber article
This gives a brief introduction to the Amber branch, and where to find documentation for it. Reviewed-by: Adam Jackson <ajax@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/18648>
Diffstat (limited to 'docs/amber.rst')
-rw-r--r--docs/amber.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/amber.rst b/docs/amber.rst
new file mode 100644
index 00000000000..d80a6db19e9
--- /dev/null
+++ b/docs/amber.rst
@@ -0,0 +1,46 @@
+Amber Branch
+============
+
+After Mesa 21.3, all non-Gallium DRI drivers were removed from the Mesa
+source-tree. These drivers are still being maintained to some degree,
+but only on the 21.3.x branch, and only for critical fixes.
+
+These drivers include:
+
+- radeon
+- r200
+- i915
+- i965
+- nouveau (the DRI driver for NV04-NV20)
+
+At the same time, the OpenSWR Gallium driver was removed from the Mesa
+source-tree, because it was already practically speaking unmaintained and
+the actively maintained LLVMpipe offers much of the same functionality.
+
+Users with Intel GPUs that were using i965 should migrate to either Iris
+or Crocus, depending on their GPU. These drivers generally speaking both
+perform better and have more features than i965 had, and due to sharing
+more code with the rest of the Mesa infrastructure, gets more bugfixes
+and features.
+
+Similarly, users of i915 should migrate to i915g (the Gallium driver for
+the same hardware), as it's still being maintained.
+
+Users who depend on the removed drivers will have to use them built from
+the Amber branch in order to get updates.
+
+Building
+--------
+
+The Amber branch has some extra logic to be able to coexist with recent
+Mesa releases without them stepping on each others toes. In order to
+enable that logic, you need to pass the ``-Damber=true`` flag to Meson.
+
+Documentation
+-------------
+
+On `docs.mesa3d.org <https://docs.mesa3d.org/>`, we currently only
+publish the documentation from our main branch. But you can view the
+documentation for the Amber branch `here
+<https://gitlab.freedesktop.org/mesa/mesa/-/tree/21.3/docs>`_.
+