mesa/docs/macos.rst
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

27 lines
1.1 KiB
ReStructuredText

Notes for macOS
================
.. image:: https://github.com/mesa3d/mesa/actions/workflows/macos.yml/badge.svg
:target: https://github.com/mesa3d/mesa/actions/workflows/macos.yml
:alt: macOS CI
Mesa builds on macOS without modifications. However, there are some details to
be aware of.
- Mesa has a number of build-time dependencies. Most dependencies, including
Meson itself, are available in `homebrew <https://brew.sh>`_, which has a
Mesa package for reference. The exception seems to be Mako, a Python module
used for templating, which you can install as ``pip3 install mako``.
- macOS is picky about its build-time environment. Type ``brew sh`` before
building to get the Homebrew dependencies in your path.
Mesa's default builds with the Apple GLX uses Mesa as a front for the
hardware-accelerated system OpenGL framework, to provide hardware acceleration
to X11 applications on macOS running via XQuartz.
Mesa's software rasterizers also work on macOS. To build, set the build options
``-Dosmesa=true -Dglx=xlib`` and select an appropriate Gallium software
rasterizer.
For native hardware, stay tuned for updates here!