mirrors/mesa
0
0
Fork 0
mirror of https://gitlab.freedesktop.org/mesa/mesa.git synced 2024-12-13 04:04:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
08c34b00df
mesa/docs/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

145 lines
2.7 KiB
ReStructuredText
Raw Normal View History

docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-31 02:27:17 +08:00
Introduction
============
The Mesa project began as an open-source implementation of the
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 20:58:40 +08:00
`OpenGL`_ specification - a system for rendering interactive 3D graphics.
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-31 02:27:17 +08:00
Over the years the project has grown to implement more graphics APIs,
docs: Even more gratutious nitpicks Signed-off-by: Daniel Stone <daniels@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11085>
2021-05-31 05:59:13 +08:00
including `OpenGL ES`_, `OpenCL`_, `OpenMAX`_, `VDPAU`_, `VA-API`_,
docs: Remove document about XvMC Signed-off-by: Yonggang Luo <luoyonggang@gmail.com> Acked-by: David Heidelberg <david.heidelberg@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19133>
2022-10-18 13:33:29 +08:00
`Vulkan`_ and `EGL`_.
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-31 02:27:17 +08:00
A variety of device drivers allows the Mesa libraries to be used in many
different environments ranging from software emulation to complete
hardware acceleration for modern GPUs.
Mesa ties into several other open-source projects: the `Direct Rendering
doc: Gratuituous promotion of Wayland This is really just a dummy commit to get the docs regenerated so we can stop 404ing. Signed-off-by: Daniel Stone <daniels@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11083>
2021-05-30 21:43:25 +08:00
Infrastructure`_, `X.org`_, and `Wayland`_ to provide OpenGL support on
Linux, FreeBSD, and other operating systems.
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 20:58:40 +08:00
.. _OpenGL: https://www.opengl.org/
.. _OpenGL ES: https://www.khronos.org/opengles/
.. _OpenCL: https://www.khronos.org/opencl/
.. _OpenMAX: https://www.khronos.org/openmax/
.. _VDPAU: https://en.wikipedia.org/wiki/VDPAU
docs: Even more gratutious nitpicks Signed-off-by: Daniel Stone <daniels@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11085>
2021-05-31 05:59:13 +08:00
.. _VA-API: https://en.wikipedia.org/wiki/Video_Acceleration_API
docs: apply some redirects Here's a few redirects that we should apply, in case the redirects gets removed in the future. These are mostly of the 301 (moved permanently) kind, but also a few where the site probably *should* have used the permanent error-code. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574>
2022-11-07 20:30:03 +08:00
.. _Vulkan: https://www.vulkan.org/
docs: mention egl in api-list Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:20:47 +08:00
.. _EGL: https://www.khronos.org/egl/
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 20:58:40 +08:00
.. _Direct Rendering Infrastructure: https://dri.freedesktop.org/
.. _X.org: https://x.org
doc: Gratuituous promotion of Wayland This is really just a dummy commit to get the docs regenerated so we can stop 404ing. Signed-off-by: Daniel Stone <daniels@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11083>
2021-05-30 21:43:25 +08:00
.. _Wayland: https://wayland.freedesktop.org
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
.. toctree::
:maxdepth: 1
:caption: Documentation
:hidden:
self
history
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>
2022-09-18 17:36:55 +08:00
amber
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
systems
license
faq
relnotes
.. toctree::
:maxdepth: 2
:caption: Download and Install
:hidden:
download
install
precompiled
.. toctree::
:maxdepth: 1
:caption: Need help?
:hidden:
lists
bugs
.. toctree::
:maxdepth: 1
:caption: User Topics
:hidden:
shading
egl
opengles
envvars
osmesa
debugging
perf
docs/u_trace: document u_trace usage Signed-off-by: Danylo Piliaiev <dpiliaiev@igalia.com> Reviewed-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16579>
2022-05-18 18:08:22 +08:00
gpu-perf-tracing
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
extensions
application-issues
docs: briefly document Gallium Nine Credits: Axel Davy, lorn10, Pavel Ondračka Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/4937 Acked-by: Filip Gawin <filip@gawin.net> Acked-by: Pavel Ondračka <pavel.ondracka@gmail.com> Signed-off-by: David Heidelberg <david.heidelberg@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/17154>
2022-06-21 06:35:09 +08:00
gallium-nine
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
viewperf
xlibdriver
teflon: Initial commit Teflon is a Gallium frontend that TensorFlow Lite can load to delegate the execution of operations in a neural network model. See docs for more. Acked-by: Christian Gmeiner <cgmeiner@igalia.com> Acked-by: Dave Airlie <airlied@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/25714>
2023-09-07 00:26:37 +08:00
teflon
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
.. toctree::
:maxdepth: 1
:caption: Drivers
:hidden:
docs: start some documentation on Anv Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com> Reviewed-by: Emma Anholt <emma@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14522>
2022-01-12 22:44:36 +08:00
drivers/anv
docs/asahi: Add initial driver docs Emma asked for some docs on how to use wrap for when wrap gets landed. This should do :-) Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16512>
2022-05-23 05:57:34 +08:00
drivers/asahi
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
drivers/d3d12
drivers/freedreno
docs/lima: add an initial page for Lima This is a cleaned up and updated version of the readme page for Lima that was until now being maintained separately. Let's move it in-tree so it is maintained along with the pages for other similar drivers. Signed-off-by: Erico Nunes <nunes.erico@gmail.com> Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com> Reviewed-by: Vasily Khoruzhick <anarsoul@gmail.com> Reviewed-by: Eric Anholt <eric@anholt.net> Reviewed-by: Qiang Yu <yuq825@gmail.com> Reviewed-by: Andreas Baierl <ichgeh@imkreisrum.de> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10406>
2021-04-22 07:15:06 +08:00
drivers/lima
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
drivers/llvmpipe
docs: Add a docs page for NVK Reviewed-by: Adam Jackson <ajax@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/24326>
2023-07-28 05:17:43 +08:00
drivers/nvk
docs: Add a stub page for Panfrost List the supported hardware with some remarks. This page should grow in the future. Signed-off-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com> Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8096>
2020-12-15 08:04:27 +08:00
drivers/panfrost
docs: Add inital PowerVR driver documentation Signed-off-by: Karmjit Mahil <Karmjit.Mahil@imgtec.com> Reviewed-by: Frank Binns <frank.binns@imgtec.com> Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/8048 Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/23992>
2023-06-23 17:38:16 +08:00
drivers/powervr
docs: add a minimal docs page for radv RADV is the last driver in Mesa that doesn't have a webpage somewhere that we can link to from mesa3d.org. So let's make a minimal docs article for it where we link to relevant information elsewhere. Reviewed-by: Timur Kristóf <timur.kristof@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/15494>
2022-03-22 03:33:25 +08:00
drivers/radv
docs: rename vmware-guest article No other drivers use the vendor in the title or path, so it seems better to not do this for the vmware-guest driver as well. So let's rename it to SVGA instead. The actual text itself makes it clear enough what it is about. This makes it stand out less in the toctree. I chose the name "WMware SVGA3D", because that's less ambigious than the "SVGA"-alternative, and was requested by VMware people.t Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com> Reviewed-by: Chia-I Wu <olvaffe@gmail.com> Acked-by: Jose Fonseca <jfonseca@vmware.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11109>
2021-06-01 19:30:44 +08:00
drivers/svga3d
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
drivers/v3d
drivers/vc4
docs: add basic documentation for venus It probably lacks some details but is a start at least. Signed-off-by: Chia-I Wu <olvaffe@gmail.com> Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10988>
2021-05-26 04:11:25 +08:00
drivers/venus
docs: import virgl docs The docuentation has been imported verbatim from https://virgil3d.github.io/. Acked-by: Chia-I Wu <olvaffe@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13836>
2021-11-17 19:16:05 +08:00
drivers/virgl
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
drivers/zink
.. toctree::
:maxdepth: 1
:caption: Developer Topics
:hidden:
repository
sourcetree
utilities
helpwanted
devinfo
codingstyle
submittingpatches
docs: move rust update policy Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/30414>
2024-07-29 22:49:59 +08:00
rust
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
releasing
release-calendar
dispatch
gallium/index
docs: Add the start of Vulkan runtime docs Reviewed-by: Ivan Briano <ivan.briano@intel.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14961>
2022-02-18 12:10:04 +08:00
vulkan/index
nir,docs: Add docs for NIR ALU instructions About half or more of the text here is actually from Connor Abbot. I've edited it a bit to bring it up-to-date and make a few things more clear. Reviewed-by: Connor Abbott <cwabbott0@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11438>
2021-06-18 21:16:18 +08:00
nir/index
docs: Begin documenting ISL This commit mostly just adds the framework required to scrape documentation out of the ISL sources and headers. The method chosen here is a combination of doxygen and breathe (a sphinx extension for doxygen integration). I'll freely admit that doxygen is pretty terrible but it seems like the best option we have available to us today. Acked-by: Emma Anholt <emma@anholt.net> Acked-by: Daniel Stone <daniels@collabora.com> Acked-by: Erik Faye-Lund <erik.faye-lund@collabora.com>. Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366>
2021-06-15 05:55:21 +08:00
isl/index
docs: Move isaspec out of drivers/freedreno Lets put it under 'Developer Topics'. Signed-off-by: Christian Gmeiner <cgmeiner@igalia.com> Acked-by: Rob Clark <robdclark@chromium.org> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/25452>
2023-09-28 18:15:29 +08:00
isaspec
docs: move rusticl readme into docs/ And convert it from Markdown to rST. Signed-off-by: Eric Engestrom <eric@engestrom.ch> Reviewed-by: Karol Herbst <kherbst@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/18568>
2022-09-13 16:16:19 +08:00
rusticl
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
android
docs: Add some notes on building for macOS I intend this page to grow as I explore more about Mesa/Darwin. Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10152>
2021-04-10 10:14:14 +08:00
macos
docs: inline contents.rst into index.rst The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 21:29:00 +08:00
Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/>
.. toctree::
:maxdepth: 1
:caption: Testing
:hidden:
conform
ci/index
.. toctree::
:maxdepth: 1
:caption: Links
:hidden:
OpenGL Website <https://www.opengl.org>
DRI Website <https://dri.freedesktop.org>
Developer Blogs <https://planet.freedesktop.org>
Reference in New Issue Copy Permalink