Skip to content

Commit

Permalink
Backport PR matplotlib#28257: Clean up some Meson-related leftovers
Browse files Browse the repository at this point in the history
  • Loading branch information
ksunden authored and meeseeksmachine committed May 20, 2024
1 parent b3cc6bf commit f3b34c1
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 23 deletions.
6 changes: 3 additions & 3 deletions doc/api/prev_api_changes/api_changes_3.5.0/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,6 @@ In order to avoid conflicting with the use of :file:`setup.cfg` by
``setup.cfg`` to ``mplsetup.cfg``. The :file:`setup.cfg.template` has been
correspondingly been renamed to :file:`mplsetup.cfg.template`.

Note that the path to this configuration file can still be set via the
:envvar:`MPLSETUPCFG` environment variable, which allows one to keep using the
same file before and after this change.
Note that the path to this configuration file can still be set via the ``MPLSETUPCFG``
environment variable, which allows one to keep using the same file before and after this
change.
7 changes: 0 additions & 7 deletions doc/install/environment_variables_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,6 @@ Environment variables
used to find a base directory in which the :file:`matplotlib` subdirectory is
created.

.. envvar:: MPLSETUPCFG

This optional variable can be set to the full path of a :file:`mplsetup.cfg`
configuration file used to customize the Matplotlib build. By default, a
:file:`mplsetup.cfg` file in the root of the Matplotlib source tree will be
read. Supported build options are listed in :file:`mplsetup.cfg.template`.

.. envvar:: PATH

The list of directories searched to find executable programs.
Expand Down
18 changes: 8 additions & 10 deletions doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,22 +121,20 @@ Before trying to install Matplotlib, please install the :ref:`dependencies`.
To build from a tarball, download the latest *tar.gz* release
file from `the PyPI files page <https://pypi.org/project/matplotlib/>`_.

We provide a `mplsetup.cfg`_ file which you can use to customize the build
process. For example, which default backend to use, whether some of the
optional libraries that Matplotlib ships with are installed, and so on. This
file will be particularly useful to those packaging Matplotlib.

.. _mplsetup.cfg: https://raw.githubusercontent.com/matplotlib/matplotlib/main/mplsetup.cfg.template

If you are building your own Matplotlib wheels (or sdists) on Windows, note
that any DLLs that you copy into the source tree will be packaged too.


Configure build and behavior defaults
=====================================

Aspects of the build and install process and some behaviorial defaults of the
library can be configured via:
We provide a `meson.options`_ file containing options with which you can use to
customize the build process. For example, which default backend to use, whether some of
the optional libraries that Matplotlib ships with are installed, and so on. These
options will be particularly useful to those packaging Matplotlib.

.. _meson.options: https://github.com/matplotlib/matplotlib/blob/main/meson.options

Aspects of some behaviorial defaults of the library can be configured via:

.. toctree::
:maxdepth: 2
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ install = ['--tags=data,python-runtime,runtime']
[tool.setuptools_scm]
version_scheme = "release-branch-semver"
local_scheme = "node-and-date"
write_to = "lib/matplotlib/_version.py"
parentdir_prefix_version = "matplotlib-"
fallback_version = "0.0+UNKNOWN"

Expand Down
4 changes: 2 additions & 2 deletions src/checkdep_freetype2.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#ifdef __has_include
#if !__has_include(<ft2build.h>)
#error "FreeType version 2.3 or higher is required. \
You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
You may set the system-freetype Meson build option to false to let Matplotlib download it."
#endif
#endif

Expand All @@ -15,5 +15,5 @@ You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib downlo
XSTR(FREETYPE_MAJOR) "." XSTR(FREETYPE_MINOR) "." XSTR(FREETYPE_PATCH) ".")
#if FREETYPE_MAJOR << 16 + FREETYPE_MINOR << 8 + FREETYPE_PATCH < 0x020300
#error "FreeType version 2.3 or higher is required. \
You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
You may set the system-freetype Meson build option to false to let Matplotlib download it."
#endif

0 comments on commit f3b34c1

Please sign in to comment.