Commit Graph

59 Commits

Author SHA1 Message Date
Marc Herbert 9102d1775d docs: move cross c*_args from [properties] to [built-in options]
Fixes the following warnings:

DEPRECATION: c_args in the [properties] section of the machine file
             is deprecated, use the [built-in options] section.
DEPRECATION: c_link_args in the [properties] section ...
DEPRECATION: cpp_args in the [properties] section ...
DEPRECATION: cpp_link_args in the [properties] section ...

These were moved in meson version 0.56.0:

https://mesonbuild.com/Machine-files.html#meson-builtin-options
https://mesonbuild.com/Release-notes-for-0-56-0.html

Mesa requires meson version 0.60 or above since commit 049086cd58

Reviewed-by: Tapani Pälli <tapani.palli@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31945>
2025-01-30 05:13:29 +00:00
Marc Herbert 75fb91501e docs: show which pkg-config Fedora uses for cross-compilation
Learned the hard way.

Only tested on Fedora but other RPM-based distros are likely to be the
same.

Reviewed-by: Tapani Pälli <tapani.palli@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31945>
2025-01-30 05:13:29 +00:00
Marc Herbert 0051807e7e docs: show how to use ccache when cross-compiling
On my desktop system, this gets compilation of (a subset of) 32bits Mesa
from 2.5 minutes down to 15 seconds - and most of what left is linking.

Also show that absolute paths are not required.

Reviewed-by: Tapani Pälli <tapani.palli@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31945>
2025-01-30 05:13:29 +00:00
Marc Herbert eaabf0e5f0 docs: cross-compile: add useful "apt" and "dnf" builddep commands
These have been tested only with x86_64->i686 cross-compilation but I
don't see why they couldn't work with other architectures if/when Linux
distributions support them. For at least x86_64->i686 cross-compilation,
these commands save an enormous amount of time.

Reviewed-by: Tapani Pälli <tapani.palli@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31945>
2025-01-30 05:13:29 +00:00
Marc Herbert 56081c0b22 docs: add "apt-get build-dep" and "dnf buildep"
So much easier and faster than installing every dependency one by one.

Reviewed-by: Tapani Pälli <tapani.palli@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/31945>
2025-01-30 05:13:28 +00:00
Matt Turner 66243e6999 docs: Drop references to LIBGL_DRIVERS_PATH
Fixes: 93511c1c5c ("gbm: link directly with libgallium")
Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/11556
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/30456>
2024-08-02 14:08:42 +00:00
Eric Engestrom d055edac11 docs/meson: add missing newline at the begining of code-block
Fixes: 324de97f48 ("docs: Add required dependencies to meson.rst")
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/30405>
2024-07-29 10:02:49 +00:00
Sai Teja Pottumuttu 324de97f48 docs: Add required dependencies to meson.rst
Add the required dependencies to build and install mesa main
on linux.

Signed-off-by: Sai Teja Pottumuttu <saiteja13427@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/30294>
2024-07-27 11:53:53 +00:00
Eric Engestrom e1e5663525 docs/meson: replace deprecated pkgconfig with pkg-config
See https://mesonbuild.com/Release-notes-for-1-3-0.html#machine-files-pkgconfig-field-deprecated-and-replaced-by-pkgconfig

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29505>
2024-06-05 10:54:25 +00:00
Eric Engestrom eb96a4bffe docs: fix syntax highlighting on shell commands
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/27010>
2024-01-12 08:13:39 +00:00
Eric Engestrom c100905796 docs: mention that python package packaging is required on python 3.12+
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26857>
2024-01-03 09:28:14 +00:00
Eric Engestrom 79bc5ff6f8 docs/meson: drop mention that our meson is ready
It's been ready for a very long time, and scons & autotools are long
gone with only meson left, so this note doesn't make much sense anymore.

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/25323>
2023-09-26 19:01:15 +00:00
Eric Engestrom 049086cd58 meson: bump minimum version to 0.60
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21485>
2023-03-10 07:20:29 +00:00
Eric Engestrom 22c1f4be8c docs: mention meson configure and drop broken workaround script
The script is broken, and nobody noticed so it wasn't used much.

Meson has had support for printing the options by pointing to the source
dir for a while (not sure the exact version though) so I think we can
just recommend users do that.

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21469>
2023-02-23 08:50:40 +00:00
Eric Engestrom e5cf283121 docs: mention the meson summary
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21469>
2023-02-23 08:50:40 +00:00
Eric Engestrom e316416dd0 docs: include explicit setup in instructions
The implicit `meson builddir/` is deprecated, and while we have fixed
our scripts, we forgot to update the docs we give our users ^^'

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Emma Anholt <emma@anholt.net>
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21468>
2023-02-22 20:07:16 +00:00
Erik Faye-Lund 7df50de210 docs: remove rogue "the"
Reviewed-by: David Heidelberg <david.heidelberg@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19719>
2022-11-15 10:01:15 +00:00
Erik Faye-Lund 018e313a76 docs: point to github for defunct link
Reviewed-by: Eric Engestrom <eric@igalia.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574>
2022-11-10 17:17:52 +01:00
Erik Faye-Lund 181d83cf2f docs: ini -> INI
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19297>
2022-11-02 10:16:44 +00:00
Erik Faye-Lund 635bf6339d docs: ArchLinux -> Arch Linux
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 86c2758404 docs: autotools -> Autotools
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 dc235de196 docs: consistently use CMake
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 6a008f34a6 docs: spell out "build directory"
This is a bit less cryptic than "builddir", and it's the same wording as
the meson docs uses.

Reviewed-by: David Heidelberg <david.heidelberg@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19191>
2022-10-25 10:06:44 +00:00
Thomas H.P. Andersen 44dba714f5 docs: update the required meson version
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14240>
2021-12-18 10:34:44 +00:00
Jan Zielinski ce4c96ea1b gallium/swr: clean up the documentation after SWR removal from main
Reviewed-by: Dylan Baker <dylan@pnwbakers.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11264>
2021-12-06 23:37:50 +00:00
Erik Faye-Lund ed04cb62d8 docs: use rst captions
This is slightly stronger semantically.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464>
2021-06-21 08:22:51 +00:00
Erik Faye-Lund e41efc173b docs: use more file-roles
This makes the documentation a bit easier to read, and aids
spell-checkers, so let's specify these using file-roles.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464>
2021-06-21 08:22:51 +00:00
Erik Faye-Lund 63c9d51981 docs: drop historic meson details
Similar to the last few commits, we require Meson 0.52 now. There's no
point in confusing users with specifying what versions supports what
here, as all supported versions works the same way now.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464>
2021-06-21 08:22:51 +00:00
Erik Faye-Lund 07cd8897fb docs: remove outdated clarification
Similar to the previous commit, we now require Meson 0.52 all the time,
so there's no point in singling this out.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464>
2021-06-21 08:22:51 +00:00
Erik Faye-Lund 309b549f0e docs: remove outdated meson-section
We're already requiring Meson 0.52, so there's no point in mentioning
this old work-around.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464>
2021-06-21 08:22:51 +00:00
Jordan Justen 57897b4095 docs: Rename master branch to main
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
2021-05-05 12:21:00 -07:00
Erik Faye-Lund 7ef9379040 docs: use code-block for ini
These code-blocks are close enough to INI-files to parse that way, so
let's use that for some syntax-coloring :)

Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10281>
2021-04-26 08:39:02 +00:00
Erik Faye-Lund 35bf5c4dca docs: optimisation -> optimization
We generally prefer US English in the docs over UK English.

Acked-by: Matt Turner <mattst88@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572>
2021-03-31 18:17:58 +02:00
Erik Faye-Lund d30470e999 docs: clang -> Clang
Reviewed-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Adam Jackson <ajax@redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7060>
2020-10-28 10:27:51 +00:00
Erik Faye-Lund 0db015294e docs: cmake -> CMake
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund 12d925dc8d docs: visual studio -> Visual Studio
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund 0e9d87eacc docs: windows -> Windows
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund 557ee09c2e docs: microsoft -> Microsoft
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund d84420f513 docs: mingw -> MinGW
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund a14d64757b docs: ninja -> Ninja
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund eb1e7e61e5 docs: chocolatey -> Chocolatey
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:21 +00:00
Erik Faye-Lund 0732efbda9 docs: mako -> Mako
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund fafd1f4425 docs: bison -> Bison
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund 1e75294e82 docs: flex -> Flex
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund d95e2e48a9 docs: python3 -> Python 3
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund e198fb64e1 docs: meson -> Meson
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund 0835ee9e8d docs: correct reference to meson.build
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Erik Faye-Lund 5ed6432eeb docs: llvm -> LLVM
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915>
2020-09-30 08:18:20 +00:00
Eric Engestrom 9497a1fbe7 docs: fix a bunch of typos
Saw a couple myself, and a quick round of vimspell showed a bunch more.

Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5814>
2020-07-09 14:06:34 +00:00
Erik Faye-Lund b1c16e5251 docs: use ref-links for internal references
Ref-link have two benefits over generic links:

1. They produce the right result for non-HTML outputs
2. They get validated at build-time

So let's use them for internal references instead.

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671>
2020-06-28 09:06:57 +00:00