Skip to content

Commit 0397288

Browse files
rgommersdnicolodi
authored andcommitted
DOC: add documentation for the custom meson config setting and env var
1 parent e35ac0d commit 0397288

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

docs/reference/environment-variables.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ Environment variables
5959
possible for ``meson-python`` to detect this, and it will not set the
6060
Python wheel platform tag accordingly.
6161

62+
.. envvar:: MESON
63+
64+
Specifies the ``meson`` executable or script to use. It overrides
65+
``tool.meson-python.meson``. See :ref:`reference-pyproject-settings` for
66+
more details.
67+
6268
.. envvar:: MESONPY_EDITABLE_VERBOSE
6369

6470
Setting this environment variable to any value enables directing to the
@@ -68,7 +74,7 @@ Environment variables
6874

6975
.. envvar:: NINJA
7076

71-
Specify the ninja_ executable to use. It can also be used to select
77+
Specifies the ninja_ executable to use. It can also be used to select
7278
ninja_ alternatives like samurai_.
7379

7480
.. _ninja: https://ninja-build.org

docs/reference/pyproject-settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ use them and examples.
2626
``-Dpython.allow_limited_api=false`` option is passed to ``meson
2727
setup``.
2828

29+
.. option:: tool.meson-python.meson
30+
31+
A string specifying the ``meson`` executable or script to use. If it is a
32+
path to an existing file with a name ending in ``.py``, it will be invoked
33+
as a Python script using the same Python interpreter that is used to run
34+
``meson-python`` itself. It can be overrridden by the :envvar:`MESON`
35+
environment variable.
36+
2937
.. option:: tool.meson-python.args.dist
3038

3139
Extra arguments to be passed to the ``meson dist`` command.

0 commit comments

Comments
 (0)