Skip to content

Commit

Permalink
docs: fix description of py.install_sources arguments
Browse files Browse the repository at this point in the history
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
  • Loading branch information
rgommers committed Nov 16, 2024
1 parent 6f67b10 commit dfd132b
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/markdown/Python-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit dfd132b

Please sign in to comment.