diff options
author | Eric Anholt <eric@anholt.net> | 2020-10-16 10:35:17 -0700 |
---|---|---|
committer | Marge Bot <eric+marge@anholt.net> | 2020-10-21 18:11:39 +0000 |
commit | 313f951f1bd5197f376f851c0f6b4414a09f92ab (patch) | |
tree | 2484dfd14c605a7d2cdf279729fac6f75dbc83d3 | |
parent | 9a644d701730cbec1a8f4d7caa94a72f21ea8e72 (diff) | |
download | external_mesa3d-313f951f1bd5197f376f851c0f6b4414a09f92ab.tar.gz external_mesa3d-313f951f1bd5197f376f851c0f6b4414a09f92ab.tar.bz2 external_mesa3d-313f951f1bd5197f376f851c0f6b4414a09f92ab.zip |
docs: Move the gallium driver documentation to the top level.
I actually had never found these, buried under Developer Topics -> Gallium
-> Drivers. Given that driver documentation contains not just gallium
driver documentation but also end-user information, bring it to a much
more prominent location between User Topics and Developer Topics at the
top level.
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174>
-rw-r--r-- | docs/conf.py | 11 | ||||
-rw-r--r-- | docs/contents.rst | 10 | ||||
-rw-r--r-- | docs/drivers/freedreno.rst (renamed from docs/gallium/drivers/freedreno.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/freedreno/ir3-notes.rst (renamed from docs/gallium/drivers/freedreno/ir3-notes.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/llvmpipe.rst (renamed from docs/gallium/drivers/llvmpipe.rst) | 4 | ||||
-rw-r--r-- | docs/drivers/openswr.rst (renamed from docs/gallium/drivers/openswr.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/openswr/faq.rst (renamed from docs/gallium/drivers/openswr/faq.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/openswr/knobs.rst (renamed from docs/gallium/drivers/openswr/knobs.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/openswr/profiling.rst (renamed from docs/gallium/drivers/openswr/profiling.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/openswr/usage.rst (renamed from docs/gallium/drivers/openswr/usage.rst) | 0 | ||||
-rw-r--r-- | docs/drivers/zink.rst (renamed from docs/gallium/drivers/zink.rst) | 0 | ||||
-rw-r--r-- | docs/gallium/drivers.rst | 9 | ||||
-rw-r--r-- | docs/gallium/index.rst | 1 | ||||
-rw-r--r-- | docs/systems.rst | 2 |
14 files changed, 23 insertions, 14 deletions
diff --git a/docs/conf.py b/docs/conf.py index 1d16c5a8a65..f699fb7818a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -136,7 +136,16 @@ html_extra_path = [ ] html_redirects = [ - ('llvmpipe', 'gallium/drivers/llvmpipe.html'), + ('gallium/drivers/freedreno', 'drivers/freedreno.html'), + ('gallium/drivers/freedreno/ir3-notes', 'drivers/freedreno/ir3-notes.html'), + ('gallium/drivers/llvmpipe', 'drivers/llvmpipe.html'), + ('gallium/drivers/openswr', 'drivers/openswr.html'), + ('gallium/drivers/openswr/faq', 'drivers/openswr/faq.html'), + ('gallium/drivers/openswr/knobs', 'drivers/openswr/knobs.html'), + ('gallium/drivers/openswr/profiling', 'drivers/openswr/profiling.html'), + ('gallium/drivers/openswr/usage', 'drivers/openswr/usage.html'), + ('gallium/drivers/zink', 'drivers/zink.html'), + ('llvmpipe', 'drivers/llvmpipe.html'), ('postprocess', 'gallium/postprocess.html'), ('webmaster', 'https://www.mesa3d.org/website/'), ] diff --git a/docs/contents.rst b/docs/contents.rst index f7fd50d5970..8b93dbe3d34 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -49,6 +49,16 @@ .. toctree:: :maxdepth: 1 + :caption: Drivers + :hidden: + + drivers/freedreno + drivers/llvmpipe + drivers/openswr + drivers/zink + +.. toctree:: + :maxdepth: 1 :caption: Developer Topics :hidden: diff --git a/docs/gallium/drivers/freedreno.rst b/docs/drivers/freedreno.rst index 723ffdde14d..723ffdde14d 100644 --- a/docs/gallium/drivers/freedreno.rst +++ b/docs/drivers/freedreno.rst diff --git a/docs/gallium/drivers/freedreno/ir3-notes.rst b/docs/drivers/freedreno/ir3-notes.rst index 2111c6fdde2..2111c6fdde2 100644 --- a/docs/gallium/drivers/freedreno/ir3-notes.rst +++ b/docs/drivers/freedreno/ir3-notes.rst diff --git a/docs/gallium/drivers/llvmpipe.rst b/docs/drivers/llvmpipe.rst index ec8e92dc0a8..a810e7dfa38 100644 --- a/docs/gallium/drivers/llvmpipe.rst +++ b/docs/drivers/llvmpipe.rst @@ -1,5 +1,5 @@ -Gallium LLVMpipe Driver -======================= +LLVMpipe +======== Introduction ------------ diff --git a/docs/gallium/drivers/openswr.rst b/docs/drivers/openswr.rst index e254d7bcea3..e254d7bcea3 100644 --- a/docs/gallium/drivers/openswr.rst +++ b/docs/drivers/openswr.rst diff --git a/docs/gallium/drivers/openswr/faq.rst b/docs/drivers/openswr/faq.rst index 1d058f92222..1d058f92222 100644 --- a/docs/gallium/drivers/openswr/faq.rst +++ b/docs/drivers/openswr/faq.rst diff --git a/docs/gallium/drivers/openswr/knobs.rst b/docs/drivers/openswr/knobs.rst index 06f228a2e92..06f228a2e92 100644 --- a/docs/gallium/drivers/openswr/knobs.rst +++ b/docs/drivers/openswr/knobs.rst diff --git a/docs/gallium/drivers/openswr/profiling.rst b/docs/drivers/openswr/profiling.rst index 357754c3506..357754c3506 100644 --- a/docs/gallium/drivers/openswr/profiling.rst +++ b/docs/drivers/openswr/profiling.rst diff --git a/docs/gallium/drivers/openswr/usage.rst b/docs/drivers/openswr/usage.rst index 61c30c27c4f..61c30c27c4f 100644 --- a/docs/gallium/drivers/openswr/usage.rst +++ b/docs/drivers/openswr/usage.rst diff --git a/docs/gallium/drivers/zink.rst b/docs/drivers/zink.rst index 18f3d433d89..18f3d433d89 100644 --- a/docs/gallium/drivers/zink.rst +++ b/docs/drivers/zink.rst diff --git a/docs/gallium/drivers.rst b/docs/gallium/drivers.rst deleted file mode 100644 index 469197c2332..00000000000 --- a/docs/gallium/drivers.rst +++ /dev/null @@ -1,9 +0,0 @@ -Drivers -======= - -Driver specific documentation. - -.. toctree:: - :glob: - - drivers/* diff --git a/docs/gallium/index.rst b/docs/gallium/index.rst index 29fbefa2eb5..82dae274a54 100644 --- a/docs/gallium/index.rst +++ b/docs/gallium/index.rst @@ -15,7 +15,6 @@ Contents: context cso distro - drivers postprocess glossary diff --git a/docs/systems.rst b/docs/systems.rst index 4543896ea63..8973deab271 100644 --- a/docs/systems.rst +++ b/docs/systems.rst @@ -31,7 +31,7 @@ Hardware drivers include: Software drivers include: -- :doc:`llvmpipe <gallium/drivers/llvmpipe>` - uses LLVM for x86 JIT code generation +- :doc:`llvmpipe <drivers/llvmpipe>` - uses LLVM for x86 JIT code generation and is multi-threaded - softpipe - a reference Gallium driver - :doc:`svga <vmware-guest>` - driver for VMWare virtual GPU |