Erik Faye-Lund
8723a18e67
docs: use envvar directive
...
When declaring an envvar, we should use the envvar directive, not the
envvar role. The latter is meant to reference the declaration, not the
other way around.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593 >
2022-11-15 11:25:05 +01:00
Erik Faye-Lund
4eef5628c8
docs: drop custom envvar directive
...
The custom envvar directive is strange. It overloads the global
namespace, where there's already a well-known envvar directive, but the
envvar role won't resolve to envvars defined using the custom directive.
It's not really critical to declare the type and default value here, and
many descriptions already include this. Let's just use the plain one,
and let the description take care of the details where needed.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593 >
2022-11-15 11:25:05 +01:00
Erik Faye-Lund
864e658c0a
docs: properly nest envvar descriptions
...
These were not nested properly, making the definitions not part of the
definition lists.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593 >
2022-11-15 11:25:05 +01:00
Erik Faye-Lund
a3a68da6ac
docs: dll -> DLL
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19719 >
2022-11-15 10:01:15 +00:00
Erik Faye-Lund
26d6f506a4
docs/asahi: use console blocks for console commands
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19719 >
2022-11-15 10:01:15 +00:00
Erik Faye-Lund
5a31e1ecaa
docs/asahi: use literal-block for build-options
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19719 >
2022-11-15 10:01:15 +00:00
Erik Faye-Lund
2ebce11137
docs/asahi: fix indent
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19719 >
2022-11-15 10:01:15 +00:00
Erik Faye-Lund
3f371d4e94
zink: remove descriptor-mode selection infrastructure
...
We only support lazy descriptors these days, so having the
infrastructure around to support automatic selection of that one mode is
kinda silly.
And it's not like setting an environment variable that is never read is
going to cause any issues, so we don't even need this to avoid breaking
existing setups.
Let's just rip it out. We can reintroduce it again on the off-chance
that someone has a new clever descriptor mode they want to experiment
with.
Reviewed-by: Hoe Hao Cheng <haochengho12907@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19670 >
2022-11-14 09:46:15 +00:00
Erik Faye-Lund
1efc92fe8c
docs/panfrost: drop anchor before channel-name
...
The use of a hash symbol in a URI is an anchor, not to indicate an IRC
channel name. This confuses the Sphinx linkchecker.
Dropping the hash here still makes the link work fine, so let's just do
that.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:26:19 +01:00
Erik Faye-Lund
67b77d8ade
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-10 17:26:19 +01:00
Erik Faye-Lund
ccb41ce06c
docs: update link to Intel intrinsics-guide
...
This link is being redirected, but not really where we want to send
people. Let's update it, so they end up in the right place.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:26:19 +01:00
Erik Faye-Lund
b925665e4e
docs: link to web.archive.org for dead links
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:17:49 +01:00
Erik Faye-Lund
217df8825c
docs: replace dead link
...
While it would be possible to dig this one up through web.archive.org,
there's a much better article written by Fabian Giesen on the subject,
so let's just link that one instead.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:17:45 +01:00
Erik Faye-Lund
1af9a8b169
docs: update dead link
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:17:42 +01:00
Erik Faye-Lund
1c4fe30466
docs: remove dead link to copy of article
...
There's no point in linking to a copy of this article on a defunct site.
So let's just remove it, the original source works just fine.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:17:39 +01:00
Erik Faye-Lund
ef05d28aa2
docs: fixup broken link syntax
...
Seems I got this slightly wrong when I fixed up the previous syntax
issue. Whoops, let's fix that!
Fixes: 6b3b633391
("docs/zink: fix and cleanup rst syntax")
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574 >
2022-11-10 17:17:25 +01:00
Erik Faye-Lund
ba78af66c6
docs: use ext-role for GL / VK extensions
...
This makes sure that we generate proper links to all of these
extensions.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Adam Jackson <ajax@redhat.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19594 >
2022-11-09 16:10:55 +00:00
Alyssa Rosenzweig
c076aeb865
docs/asahi: Document drm-shim
...
Explain how to build drm-shim and how to use it for shader-db.
Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19540 >
2022-11-07 16:10:11 +00:00
Erik Faye-Lund
9b55f1c12b
docs: upgrade some links to https
...
We're in 2022 now, and HTTPS is available in a lot more places in the
past. Let's upgrade some links, to protect the privacy of our readers.
The links that are left either don't support HTTPS, or are simply dead
and needs to be updated anyway. That's besides the scope of this
merge-request, so I'm leaving that for someone else.
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19492 >
2022-11-07 10:58:12 +00:00
Erik Faye-Lund
e5f9a9998d
docs: use anonymous links when possible
...
Anonymous links has some benefits in that it reduces the chance of
warnings when similar identifiers are used. So let's use them instead
when we can.
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19492 >
2022-11-07 10:58:12 +00:00
Erik Faye-Lund
6b3b633391
docs/zink: fix and cleanup rst syntax
...
This new section didn't use the correct RST syntax, and ended up
with a broken section in the rendered docs.
Fix the syntax, and clean things up a bit to avoid overly long lines.
Fixes: be235edfe2
("zink: add profile documentation")
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19481 >
2022-11-07 10:52:35 +00:00
Erik Faye-Lund
40bd7b4307
docs: use code-block
...
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19494 >
2022-11-04 16:38:06 +00:00
Erik Faye-Lund
8458451180
docs: fix a couple of links
...
This was broken RST syntax, and lead to a couple of rogue cite-tags in
the rendered HTML.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19494 >
2022-11-04 16:38:06 +00:00
Erik Faye-Lund
5525d0b196
docs: use inline-code instead of default role
...
A single backtick escaped string in Sphinx refers to the "default role"
which is vague, and in practice ends up producing the HTML cite-element.
That's almost certainly not what these uses wanted.
A bunch of these would probably be better served using appropriate roles
instead of inline-code markup, but this is almost certainly what was
meant here instead. Let's not let perfect be the enemy of good here, and
just do what was intended. Using the right roles everywhere is a big
task.
I usually don't do changes like these to the relnotes, but in this case
there were a *single* article that had these mistakes. I assume that was
an early bug in the script that generateg the relnotes. Let's patch it,
so we don't get misrendering if we change the default-role.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19494 >
2022-11-04 16:38:06 +00:00
Yonggang Luo
110c1aa461
docs: There is only glx=xlib option now
...
Signed-off-by: Yonggang Luo <luoyonggang@gmail.com >
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19459 >
2022-11-02 11:10:15 +00:00
Yonggang Luo
6d2ed45396
docs: -Ddri-drivers= option is deprecated, do not use it anymore
...
Signed-off-by: Yonggang Luo <luoyonggang@gmail.com >
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19459 >
2022-11-02 11:10:15 +00:00
Erik Faye-Lund
f748cf54c6
docs: gitlab -> GitLab
...
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297 >
2022-11-02 10:16:44 +00:00
Erik Faye-Lund
fdab007b1d
docs: do not mention classic swrast
...
It's been removed a while back, no need to talk about it anymore.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297 >
2022-11-02 10:16:44 +00:00
Erik Faye-Lund
9fea95d907
docs: Adreno aXXX -> Adreno XXX
...
The names of these are "Adreno XXX" or "aXXX", not "Adreno aXXX".
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297 >
2022-11-02 10:16:44 +00:00
Erik Faye-Lund
cf0b5a60f4
docs: xml -> XML
...
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297 >
2022-11-02 10:16:44 +00:00
Erik Faye-Lund
ac031f66c3
docs: softpipe -> Softpipe
...
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297 >
2022-11-02 10:16:44 +00:00
jenneron
d9f0fef91d
docs/panfrost: Document Mali-T620 support
...
This one is already supported
Signed-off-by: Anton Bambura <jenneron@protonmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19415 >
2022-10-31 18:53:24 +00:00
Christophe
be235edfe2
zink: add profile documentation
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19192 >
2022-10-26 19:02:20 +00:00
Erik Faye-Lund
87eb4f4f4f
docs: vmware -> VMware
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
d33eb01843
docs: virtualisation -> virtualization
...
We generally perfer US English spelling in our docs, so let's fix up
this one word.
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
f2e688f042
docs: hw -> HW
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
1298c5df69
docs: meson -> Meson
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
3196f71361
docs: ppir -> PPIR
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
b244128954
docs: lima -> Lima
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
f69fe8c279
docs: llvmpipe -> LLVMpipe
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
8e09975562
docs: adreno -> Adreno
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
6dbb184ad7
docs: gpu -> GPU
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
a590043c77
docs: cpu -> CPU
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
deb5529385
docs: xorg -> X.Org
...
Also one case of Xorg
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
f4b0689eec
docs: irc -> IRC
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
7041cf6612
docs: use consistent casing for dEQP
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
e855f5a060
docs: consistently spell VirGL in camel-case
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
dc235de196
docs: consistently use CMake
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
1ed2878755
docs: consistently spell ANV in allcaps
...
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00
Erik Faye-Lund
8e4725e879
docs: consistently upper-case VC4, V3D etc
...
This is how we're doing this elsewhere in the docs, and upper-casing is
a clear indication that this is a name.
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191 >
2022-10-25 10:06:45 +00:00