summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2026-04-16 03:41:37 +1000
committer Vas Crabb <vas@vastheman.com>2026-04-16 03:41:37 +1000
commit6d0d50b450a7e8307c6c5046bedc5dcd5fcb2185 (patch)
tree85e1ce95c6141f7d11a67ece368f89e3d03401be /docs
parent0ff8ec15a3bef83a8e4a725f3e124e5e4601e0b6 (diff)
-bus/ieee488: Cleaned up code, improved displayed device names.
-docs: Reorganised listing of MSYS2 packages for building documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/initialsetup/compilingmame.rst44
1 files changed, 25 insertions, 19 deletions
diff --git a/docs/source/initialsetup/compilingmame.rst b/docs/source/initialsetup/compilingmame.rst
index bc1ce29c66a..7a248928c56 100644
--- a/docs/source/initialsetup/compilingmame.rst
+++ b/docs/source/initialsetup/compilingmame.rst
@@ -111,23 +111,6 @@ These instructions assume you have some familiarity with MSYS2 and the
* Install packages necessary to build MAME. At the very least, you’ll need
``bash``, ``git`` and ``make``.
* For debugging you may want to install ``gdb``.
-* To build the HTML user/developer documentation, you’ll need
- ``mingw-w64-clang-x86_64-librsvg``, ``mingw-w64-clang-x86_64-python-sphinx``,
- ``mingw-w64-clang-x86_64-python-sphinx_rtd_theme`` and
- ``mingw-w64-clang-x86_64-python-sphinxcontrib-svg2pdfconverter`` for a CLANG64
- environment (or alternatively ``mingw-w64-clang-aarch64-librsvg``,
- ``mingw-w64-clang-aarch64-python-sphinx``,
- ``mingw-w64-clang-aarch64-python-sphinx_rtd_theme`` and
- ``mingw-w64-clang-aarch64-python-sphinxcontrib-svg2pdfconverter`` a CLANGARM64
- environment).
-* To build the PDF documentation, you’ll additionally need
- ``mingw-w64-ucrt-x86_64-texlive-latex-extra`` and
- ``mingw-w64-ucrt-x86_64-texlive-fonts-recommended`` for a UCRT64 environment,
- or ``mingw-w64-clang-x86_64-texlive-latex-extra`` and
- ``mingw-w64-clang-x86_64-texlive-fonts-recommended`` for a CLANG64
- environment. You must build the PDF documentation using the UCRT64 or CLANG64
- environment as the TeX Live tools currently do not work with the CLANGARM64
- environment.
* To generate API documentation from source, you’ll need ``doxygen``.
* If you plan to rebuild bgfx shaders and you want to rebuild the GLSL parser,
you’ll need ``bison``.
@@ -148,6 +131,13 @@ building for.
* To build against the portable SDL interfaces, you’ll need
``mingw-w64-ucrt-x86_64-SDL2`` and ``mingw-w64-ucrt-x86_64-SDL2_ttf``.
* To build the Qt debugger, you’ll need ``mingw-w64-ucrt-x86_64-qt6-base``.
+* To build the HTML user/developer documentation, you’ll need
+ ``mingw-w64-ucrt-x86_64-librsvg``, ``mingw-w64-ucrt-x86_64-python-sphinx``,
+ ``mingw-w64-ucrt-x86_64-python-sphinx_rtd_theme`` and
+ ``mingw-w64-ucrt-x86_64-python-sphinxcontrib-svg2pdfconverter``.
+* To build the PDF documentation, you’ll additionally need
+ ``mingw-w64-ucrt-x86_64-texlive-latex-extra`` and
+ ``mingw-w64-ucrt-x86_64-texlive-fonts-recommended``.
* Open the **ucrt64.exe** helper from the **msys64** installation folder or the
**MSYS2 UCRT64** shortcut from the start menu to start a Bash shell configured
with the correct paths and environment variables.
@@ -163,6 +153,13 @@ building for.
* To build against the portable SDL interfaces, you’ll need
``mingw-w64-clang-x86_64-SDL2`` and ``mingw-w64-clang-x86_64-SDL2_ttf``.
* To build the Qt debugger, you’ll need ``mingw-w64-clang-x86_64-qt6-base``.
+* To build the HTML user/developer documentation, you’ll need
+ ``mingw-w64-clang-x86_64-librsvg``, ``mingw-w64-clang-x86_64-python-sphinx``,
+ ``mingw-w64-clang-x86_64-python-sphinx_rtd_theme`` and
+ ``mingw-w64-clang-x86_64-python-sphinxcontrib-svg2pdfconverter``.
+* To build the PDF documentation, you’ll additionally need
+ ``mingw-w64-clang-x86_64-texlive-latex-extra`` and
+ ``mingw-w64-clang-x86_64-texlive-fonts-recommended``.
* Open the **clang64.exe** helper from the **msys64** installation folder or use
the **MSYS2 CLANG64** shortcut to start a Bash shell configured with the
correct paths and environment variables.
@@ -178,6 +175,15 @@ building for.
* To build against the portable SDL interfaces, you’ll need
``mingw-w64-clang-aarch64-SDL2`` and ``mingw-w64-clang-aarch64-SDL2_ttf``.
* To build the Qt debugger, you’ll need ``mingw-w64-clang-aarch64-qt6-base``.
+* To build the HTML user/developer documentation, you’ll need
+ ``mingw-w64-clangarm64-x86_64-librsvg``,
+ ``mingw-w64-clangarm64-x86_64-python-sphinx``,
+ ``mingw-w64-clangarm64-x86_64-python-sphinx_rtd_theme`` and
+ ``mingw-w64-clangarm64-x86_64-python-sphinxcontrib-svg2pdfconverter``.
+* It is not currently possible to build the PDF documentation using the
+ CLANGARM64 environment as the TeX Live tools do not work. You may be able
+ to use the UCRT64 or CLANG64 environment to build the PDF documentation on a
+ 64-bit ARM system.
* Open the **clangarm64.exe** helper from the **msys64** installation folder or
use the **MSYS2 CLANGARM64** shortcut to start a Bash shell configured with
the correct paths and environment variables.
@@ -457,7 +463,7 @@ can install these packages with
pacman -S mingw-w64-x86_64-librsvg mingw-w64-x86_64-python-sphinx mingw-w64-x86_64-python-sphinxcontrib-svg2pdfconverter
If you intend to make a PDF via LaTeX, you’ll need to install a LaTeX
-distribution such as TeX Live:
+distribution such as TeX Live:
.. code-block:: bash
@@ -483,7 +489,7 @@ On Debian, you’ll need to install the **librsvg2-bin** package:
sudo apt-get install librsvg2-bin
If you intend to make a PDF via LaTeX, you’ll need to install a LaTeX
-distribution such as TeX Live:
+distribution such as TeX Live:
.. code-block:: bash