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
Erik Faye-Lund
d20bfeaa89
docs: drop rogue backtick
...
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
Erik Faye-Lund
293d8eb20e
docs: use c:expr role shorthand
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19575 >
2022-11-09 12:09:17 +00:00
Erik Faye-Lund
4be9600ccb
docs: remove needless c:expr roles
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19575 >
2022-11-09 12:09:17 +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
Erik Faye-Lund
ab1727237a
docs/isl: remove empty headings
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19461 >
2022-11-03 07:46:13 +00:00
Erik Faye-Lund
d2b3ebf0d8
docs/isl: put emphasis on unit names
...
This convinces the spell-checker that this is something meaniningful, it
seems...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19461 >
2022-11-03 07:46:13 +00:00
Erik Faye-Lund
05a081f7ee
docs/isl: correct rst-syntax
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19461 >
2022-11-03 07:46:13 +00:00
Erik Faye-Lund
e9c494e24a
docs: consistently spell Haswell 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
4a229fea22
docs: XOR'd -> XORed
...
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
f8d047c08b
docs: correct spelling of "laid"
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19139 >
2022-10-19 11:18:50 +00:00
Erik Faye-Lund
9d55200e72
docs: correct spelling of "compression"
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19139 >
2022-10-19 11:18:50 +00:00
Erik Faye-Lund
e2ee7e03da
docs: correct spelling of "hierarchical"
...
Reviewed-by: Eric Engestrom <eric@igalia.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19139 >
2022-10-19 11:18:50 +00:00
Eric Engestrom
8317de8ed3
docs/isl: fix typos & formatting
...
Signed-off-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Jason Ekstrand <jason.ekstrand@collabora.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/17522 >
2022-07-15 15:17:45 +00:00
Jason Ekstrand
3c3b75a2b7
isl/docs/tiling: Add Tile4 docs
...
Reviewed-by: Nanley Chery <nanley.g.chery@intel.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/12550 >
2021-08-28 02:49:18 +00:00
Jason Ekstrand
938ce8cdaf
docs/isl/tiling: Fix swizzle pattern for X-tiling
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11679 >
2021-07-01 14:07:42 -05:00
Jason Ekstrand
7fb70ee2d5
docs/isl: Improve the bit[6] swizzling section of the tiling chapter
...
Suggested-by: Luis Strano <luis.strano@intel.com >
Acked-by: Luis Strano <luis.strano@intel.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11479 >
2021-06-24 13:57:40 +00:00
Jason Ekstrand
b8030ab1ea
isl,docs: Add a chapter on AUX state tracking
...
We also update and improve the docs in isl.h which get pulled into this
new chapter.
Acked-by: Luis Strano <luis.strano@intel.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11479 >
2021-06-24 13:57:40 +00:00
Jason Ekstrand
806498eee8
docs/isl: Consistently use 3-space tabs
...
Reviewed-by: Connor Abbott <cwabbott0@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11529 >
2021-06-22 17:37:55 +00:00
Jason Ekstrand
d3ea8f519e
docs,isl: Document Sandy Bridge HiZ/stencil
...
This is annoying and tricky and we don't have all the gory details
written down in one central place anywhere. Add a docs section on it.
Reviewed-by: Emma Anholt <emma@anholt.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11500 >
2021-06-21 22:54:31 +00:00
Jason Ekstrand
b97dedd365
docs/isl: Add detailed documentation about CCS compression
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366 >
2021-06-18 13:03:48 +00:00
Jason Ekstrand
6b15ce9fa2
docs/isl: Add detailed documentation about tiling on Intel GPUs
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366 >
2021-06-18 13:03:48 +00:00
Jason Ekstrand
0f6ebd2b73
docs/isl: Add detailed documentation about isl formats
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366 >
2021-06-18 13:03:48 +00:00
Jason Ekstrand
3894e42590
docs/isl: Document ISL's units
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366 >
2021-06-18 13:03:48 +00:00
Jason Ekstrand
831750b40b
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-18 13:03:48 +00:00