diff options
| author | Ralf Gommers <ralf.gommers@gmail.com> | 2024-11-16 19:58:07 +0100 |
|---|---|---|
| committer | Eli Schwartz <eschwartz93@gmail.com> | 2024-11-17 19:32:31 -0500 |
| commit | 731dcdf92fdb0e4675f61e028eb83ff31e8893f5 (patch) | |
| tree | 1d9f9bfc3c1fd8a4fb8499c81c1f024fc8574749 /docs | |
| parent | d76f739bffdfcf298ed83bd829045b9a12f43f8e (diff) | |
| download | meson-731dcdf92fdb0e4675f61e028eb83ff31e8893f5.zip meson-731dcdf92fdb0e4675f61e028eb83ff31e8893f5.tar.gz meson-731dcdf92fdb0e4675f61e028eb83ff31e8893f5.tar.bz2 | |
docs: fix description of `py.install_sources` arguments
There is actually very little overlap between `install_sources` and
`install_data` in arguments they accept: only 2/7 keywords for `install_data`
apply to `install_sources`.
Closes gh-12601
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Python-module.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/markdown/Python-module.md b/docs/markdown/Python-module.md index cd2a641..1ea5e64 100644 --- a/docs/markdown/Python-module.md +++ b/docs/markdown/Python-module.md @@ -121,7 +121,7 @@ Additionally, the following diverge from [[shared_module]]'s default behavior: - `gnu_symbol_visibility`: if unset, it will default to `'hidden'` on versions of Python that support this (the python headers define `PyMODINIT_FUNC` has default visibility). - + Note that Cython support uses `extension_module`, see [the reference for Cython](Cython.md). *since 0.63.0* `extension_module` automatically adds a dependency to the library @@ -158,11 +158,8 @@ void py_installation.install_sources(list_of_files, ...) Install actual python sources (`.py`). -All positional and keyword arguments are the same as for -[[install_data]], with the addition of the following: - -*Since 0.60.0* `python.platlibdir` and `python.purelibdir` options can be used -to control the default installation path. See [Python module options](Builtin-options.md#python-module). +Source files to install are given as positional argument, in the same way as for +[[install_data]]. Supported keyword arguments are: - `pure`: On some platforms, architecture independent files are expected to be placed in a separate directory. However, if the @@ -177,6 +174,12 @@ to control the default installation path. See [Python module options](Builtin-op - `install_tag` *(since 0.60.0)*: A string used by `meson install --tags` command to install only a subset of the files. By default it has the tag `python-runtime`. +- `preserve_path`: if `true`, disable stripping child-directories from data + files when installing. Default is `false`. *(since 0.64.0)* + +*Since 0.60.0* `python.platlibdir` and `python.purelibdir` options can be used +to control the default installation path. See [Python module options](Builtin-options.md#python-module). + #### `get_install_dir()` ``` meson |