From 313f951f1bd5197f376f851c0f6b4414a09f92ab Mon Sep 17 00:00:00 2001 From: Eric Anholt Date: Fri, 16 Oct 2020 10:35:17 -0700 Subject: [PATCH] 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 Part-of: --- docs/conf.py | 11 ++++++++++- docs/contents.rst | 10 ++++++++++ docs/{gallium => }/drivers/freedreno.rst | 0 docs/{gallium => }/drivers/freedreno/ir3-notes.rst | 0 docs/{gallium => }/drivers/llvmpipe.rst | 4 ++-- docs/{gallium => }/drivers/openswr.rst | 0 docs/{gallium => }/drivers/openswr/faq.rst | 0 docs/{gallium => }/drivers/openswr/knobs.rst | 0 docs/{gallium => }/drivers/openswr/profiling.rst | 0 docs/{gallium => }/drivers/openswr/usage.rst | 0 docs/{gallium => }/drivers/zink.rst | 0 docs/gallium/drivers.rst | 9 --------- docs/gallium/index.rst | 1 - docs/systems.rst | 2 +- 14 files changed, 23 insertions(+), 14 deletions(-) rename docs/{gallium => }/drivers/freedreno.rst (100%) rename docs/{gallium => }/drivers/freedreno/ir3-notes.rst (100%) rename docs/{gallium => }/drivers/llvmpipe.rst (99%) rename docs/{gallium => }/drivers/openswr.rst (100%) rename docs/{gallium => }/drivers/openswr/faq.rst (100%) rename docs/{gallium => }/drivers/openswr/knobs.rst (100%) rename docs/{gallium => }/drivers/openswr/profiling.rst (100%) rename docs/{gallium => }/drivers/openswr/usage.rst (100%) rename docs/{gallium => }/drivers/zink.rst (100%) delete mode 100644 docs/gallium/drivers.rst 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 @@ -47,6 +47,16 @@ viewperf xlibdriver +.. toctree:: + :maxdepth: 1 + :caption: Drivers + :hidden: + + drivers/freedreno + drivers/llvmpipe + drivers/openswr + drivers/zink + .. toctree:: :maxdepth: 1 :caption: Developer Topics diff --git a/docs/gallium/drivers/freedreno.rst b/docs/drivers/freedreno.rst similarity index 100% rename from docs/gallium/drivers/freedreno.rst rename to docs/drivers/freedreno.rst diff --git a/docs/gallium/drivers/freedreno/ir3-notes.rst b/docs/drivers/freedreno/ir3-notes.rst similarity index 100% rename from docs/gallium/drivers/freedreno/ir3-notes.rst rename to docs/drivers/freedreno/ir3-notes.rst diff --git a/docs/gallium/drivers/llvmpipe.rst b/docs/drivers/llvmpipe.rst similarity index 99% rename from docs/gallium/drivers/llvmpipe.rst rename to 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 similarity index 100% rename from docs/gallium/drivers/openswr.rst rename to docs/drivers/openswr.rst diff --git a/docs/gallium/drivers/openswr/faq.rst b/docs/drivers/openswr/faq.rst similarity index 100% rename from docs/gallium/drivers/openswr/faq.rst rename to docs/drivers/openswr/faq.rst diff --git a/docs/gallium/drivers/openswr/knobs.rst b/docs/drivers/openswr/knobs.rst similarity index 100% rename from docs/gallium/drivers/openswr/knobs.rst rename to docs/drivers/openswr/knobs.rst diff --git a/docs/gallium/drivers/openswr/profiling.rst b/docs/drivers/openswr/profiling.rst similarity index 100% rename from docs/gallium/drivers/openswr/profiling.rst rename to docs/drivers/openswr/profiling.rst diff --git a/docs/gallium/drivers/openswr/usage.rst b/docs/drivers/openswr/usage.rst similarity index 100% rename from docs/gallium/drivers/openswr/usage.rst rename to docs/drivers/openswr/usage.rst diff --git a/docs/gallium/drivers/zink.rst b/docs/drivers/zink.rst similarity index 100% rename from docs/gallium/drivers/zink.rst rename to 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 ` - uses LLVM for x86 JIT code generation +- :doc:`llvmpipe ` - uses LLVM for x86 JIT code generation and is multi-threaded - softpipe - a reference Gallium driver - :doc:`svga ` - driver for VMWare virtual GPU