Skip to content

Commit 6d5d757

Browse files
authored
doc: add docs on swig-abi metapackage (#2642)
* doc: add swig abi bits * fix: remove vscode junk * fix: update gitignore to exclude vscode items * style: pre-the-commit
1 parent 4e69b65 commit 6d5d757

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,6 @@ yarn-error.log*
5454
# pyc files
5555
*.pyc
5656
__pycache__/
57+
58+
# vscode stuff
59+
.vscode

docs/maintainer/knowledge_base.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1402,13 +1402,16 @@ if you import parts of `matplotlib` that link to `libX11`.
14021402

14031403
<a id="pybind11-abi-constraints"></a>
14041404

1405-
### `pybind11` ABI Constraints
1405+
<a id="pybind11-swig-abi-constraints"></a>
14061406

1407-
Sometimes when different python libraries using `pybind11` interact via lower-level C++ interfaces,
1408-
the underlying ABI between the two libraries has to match. To ease this use case, we have a `pybind11-abi`
1409-
metapackage that can be used in the `host` section of a build. Its version is pinned globally and it has a
1407+
### `pybind11` and `swig` ABI Constraints
1408+
1409+
Sometimes when different python libraries using `pybind11`/`swig` interact via lower-level interfaces,
1410+
the underlying ABI between the two libraries has to match. To ease this use case, we have a `pybind11-abi`/`swig-abi`
1411+
metapackage that can be used in the `host` section of a build. Its version is pinned globally, and it has a
14101412
run export on itself, meaning that builds with this package in `host` will have a runtime constraint on it.
1411-
Further, the `pybind11` has a run constraint on the ABI metapackage to help ensure consistent usage.
1413+
Further, the `pybind11`/`swig` has a run constraint on the respective ABI metapackage to help ensure
1414+
consistent usage.
14121415

14131416
To use this package in a build, put it in the host environment like so
14141417

@@ -1418,6 +1421,14 @@ requirements:
14181421
- pybind11-abi
14191422
```
14201423

1424+
or
1425+
1426+
```yaml
1427+
requirements:
1428+
host:
1429+
- swig-abi
1430+
```
1431+
14211432
<a id="knowledge-empty"></a>
14221433

14231434
<a id="empty-python-packages"></a>

0 commit comments

Comments
 (0)