DOC: add documentation for the custom meson config setting and env var

mesonbuild · Sep 12, 2023 · 548ab9b · 548ab9b
1 parent db93d14
commit 548ab9b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/reference/environment-variables.rst b/docs/reference/environment-variables.rst
@@ -59,6 +59,12 @@ Environment variables
    possible for ``meson-python`` to detect this, and it will not set the
    Python wheel platform tag accordingly.
 
+.. envvar:: MESON
+
+   Specify the ``meson`` executable or script to use. It overrides
+   ``tool.meson-python.meson``. See :ref:`reference-pyproject-settings` for
+   more details.
+
 .. envvar:: MESONPY_EDITABLE_VERBOSE
 
    Setting this environment variable to any value enables directing to the

diff --git a/docs/reference/pyproject-settings.rst b/docs/reference/pyproject-settings.rst
@@ -26,6 +26,17 @@ use them and examples.
    ``-Dpython.allow_limited_api=false`` option is passed to ``meson
    setup``.
 
+.. option:: tool.meson-python.meson
+
+   A string identifying a custom version of ``meson``. It may be an executable
+   name, or a path to an executable or script. If it's a path to a file that
+   exists and the string ends in ``.py``, then it will be invoked as a script
+   with the same Python interpreter that is used to run meson-python itself.
+
+   If this setting is used, it will be used for all invocation of ``meson``.
+   It can be overridden by a ``$MESON`` environment variable (see
+   :ref:`reference-environment-variables`).
+
 .. option:: tool.meson-python.args.dist
 
    Extra arguments to be passed to the ``meson dist`` command.