Skip to content

Commit b92fc1a

Browse files
committed
docs: fix more refs to be toml style
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 0e70ab9 commit b92fc1a

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

docs/options.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This option can also be set using the [command-line option](#command-line) `--pl
4646
4747
List of builds to build and skip. Each build has an identifier like `cp38-manylinux_x86_64` or `cp37-macosx_x86_64` - you can list specific ones to build and cibuildwheel will only build those, and/or list ones to skip and cibuildwheel won't try to build them.
4848

49-
When both options are specified, both conditions are applied and only builds with a tag that matches `CIBW_BUILD` and does not match `CIBW_SKIP` will be built.
49+
When both options are specified, both conditions are applied and only builds with a tag that matches `build` and does not match `skip` will be built.
5050

5151
When setting the options, you can use shell-style globbing syntax, as per [fnmatch](https://docs.python.org/3/library/fnmatch.html) with the addition of curly bracket syntax `{option1,option2}`, provided by [bracex](https://pypi.org/project/bracex/). All the build identifiers supported by cibuildwheel are shown below:
5252

@@ -69,7 +69,7 @@ The list of supported and currently selected build identifiers can also be retri
6969
The format is `python_tag-platform_tag`, with tags similar to those in [PEP 425](https://www.python.org/dev/peps/pep-0425/#details).
7070

7171
Windows arm64 platform support is experimental.
72-
Linux riscv64 platform support is experimental and requires an explicit opt-in through [CIBW_ENABLE](#enable).
72+
Linux riscv64 platform support is experimental and requires an explicit opt-in through [`enable`](#enable).
7373

7474
See the [cibuildwheel 2 documentation](https://cibuildwheel.pypa.io/en/2.x/) for past end-of-life versions of Python.
7575

@@ -144,7 +144,7 @@ See the [cibuildwheel 2 documentation](https://cibuildwheel.pypa.io/en/2.x/) for
144144

145145
It is generally recommended to set `CIBW_BUILD` as an environment variable, though `skip`
146146
tends to be useful in a config file; you can statically declare that you don't
147-
support PyPy, for example.
147+
support a specific build, for example.
148148

149149
<style>
150150
.build-id-table-marker + table {
@@ -190,10 +190,10 @@ Options:
190190
- `auto32`: Just the 32-bit auto archs
191191
- `native`: the native arch of the build machine - Matches [`platform.machine()`](https://docs.python.org/3/library/platform.html#platform.machine).
192192
- `all` : expands to all the architectures supported on this OS. You may want
193-
to use [CIBW_BUILD](#build-skip) with this option to target specific
193+
to use [`build`](#build-skip) with this option to target specific
194194
architectures via build selectors.
195195

196-
Linux riscv64 platform support is experimental and requires an explicit opt-in through [CIBW_ENABLE](#enable).
196+
Linux riscv64 platform support is experimental and requires an explicit opt-in through [`enable`](#enable).
197197

198198
Default: `auto`
199199

@@ -205,7 +205,7 @@ Default: `auto`
205205
| macOS / Intel | `x86_64` | `x86_64` | `x86_64` | |
206206
| macOS / Apple Silicon | `arm64` | `arm64` | `arm64` | |
207207
| iOS on macOS / Intel | `x86_64_iphonesimulator` | `x86_64_iphonesimulator` | `x86_64_iphonesimulator` | |
208-
| iOS on macOS / Apple Silicon | `arm64_iphonesimulator` | `arm64_iphoneos` `arm64_iphonesimulator` | `arm64_iphoneos` `arm64_iphonesimulator` | |
208+
| iOS on macOS / Apple Silicon | `arm64_iphonesimulator` | `arm64_iphoneos` `arm64_iphonesimulator` | `arm64_iphoneos` `arm64_iphonesimulator` |
209209

210210
If not listed above, `auto` is the same as `native`.
211211

@@ -305,7 +305,7 @@ the package is compatible with all versions of Python that it can build.
305305
CIBW_PROJECT_REQUIRES_PYTHON: ">=3.8"
306306
```
307307

308-
### `CIBW_ENABLE` {: #enable toml env-var}
308+
### `enable` {: #enable toml env-var}
309309
> Enable building with extra categories of selectors present.
310310
311311
This option lets you opt-in to non-default builds, like pre-releases and
@@ -347,7 +347,7 @@ This option doesn't support overrides or platform specific variants; it is
347347
intended as a way to acknowledge that a project is aware that these extra
348348
selectors exist. If you need to enable/disable it per platform or python
349349
version, set this option to `true` and use
350-
[`CIBW_BUILD`](#build-skip)/[`CIBW_SKIP`](#build-skip) options to filter the
350+
[`build`](#build-skip)/[`skip`](#build-skip) options to filter the
351351
builds.
352352

353353
Unlike all other cibuildwheel options, the environment variable setting will
@@ -671,7 +671,7 @@ This option is very useful for the Linux build, where builds take place in isola
671671

672672
The placeholder `{package}` can be used here; it will be replaced by the path to the package being built by cibuildwheel.
673673

674-
On Windows and macOS, the version of Python available inside `CIBW_BEFORE_ALL` is whatever is available on the host machine. On Linux, a modern Python version is available on PATH.
674+
On Windows and macOS, the version of Python available inside `before-all` is whatever is available on the host machine. On Linux, a modern Python version is available on PATH.
675675

676676
This option has special behavior in the overrides section in `pyproject.toml`.
677677
On linux, overriding it triggers a new container launch. It cannot be overridden
@@ -682,7 +682,7 @@ Platform-specific environment variables also available:<br/>
682682

683683
!!! note
684684

685-
This command is executed in a different Python environment from the builds themselves. So you can't `pip install` a Python dependency in CIBW_BEFORE_ALL and use it in the build. Instead, look at [`CIBW_BEFORE_BUILD`](#before-build), or, if your project uses pyproject.toml, the [build-system.requires](https://peps.python.org/pep-0518/#build-system-table) field.
685+
This command is executed in a different Python environment from the builds themselves. So you can't `pip install` a Python dependency in `before-all` and use it in the build. Instead, look at [`before-build`](#before-build), or, if your project uses pyproject.toml, the [build-system.requires](https://peps.python.org/pep-0518/#build-system-table) field.
686686

687687
#### Examples
688688

@@ -729,7 +729,7 @@ Platform-specific environment variables also available:<br/>
729729

730730
Note that `manylinux_2_31` builds occur inside a Debian derivative docker
731731
container, where `manylinux2014` builds occur inside a CentOS one. So for
732-
`manylinux_2_31` the `CIBW_BEFORE_ALL_LINUX` command must use `apt-get -y`
732+
`manylinux_2_31` the `before-all` command must use `apt-get -y`
733733
instead.
734734

735735
### `before-build` {: #before-build env-var toml}
@@ -820,13 +820,13 @@ Platform-specific environment variables are also available:<br/>
820820
821821
When building in a cross-platform environment, it is sometimes necessary to isolate the ``PATH`` so that binaries from the build machine don't accidentally get linked into the cross-platform binary. However, this isolation process will also hide tools that might be required to build your wheel.
822822

823-
If there are binaries present on the `PATH` when you invoke cibuildwheel, and those binaries are required to build your wheels, those binaries can be explicitly included in the isolated cross-build environment using `CIBW_XBUILD_TOOLS`. The binaries listed in this setting will be linked into an isolated location, and that isolated location will be put on the `PATH` of the isolated environment. You do not need to provide the full path to the binary - only the executable name that would be found by the shell.
823+
If there are binaries present on the `PATH` when you invoke cibuildwheel, and those binaries are required to build your wheels, those binaries can be explicitly included in the isolated cross-build environment using `xbuild-tools`. The binaries listed in this setting will be linked into an isolated location, and that isolated location will be put on the `PATH` of the isolated environment. You do not need to provide the full path to the binary - only the executable name that would be found by the shell.
824824

825825
If you declare a tool as a cross-build tool, and that tool cannot be found in the runtime environment, an error will be raised.
826826

827-
If you do not define `CIBW_XBUILD_TOOLS`, and you build for a platform that uses a cross-platform environment, a warning will be raised. If your project does not require any cross-build tools, you can set `CIBW_XBUILD_TOOLS` to an empty list to silence this warning.
827+
If you do not define `xbuild-tools`, and you build for a platform that uses a cross-platform environment, a warning will be raised. If your project does not require any cross-build tools, you can set `xbuild-tools` to an empty list to silence this warning.
828828

829-
*Any* tool used by the build process must be included in the `CIBW_XBUILD_TOOLS` list, not just tools that cibuildwheel will invoke directly. For example, if your build invokes `cmake`, and the `cmake` script invokes `magick` to perform some image transformations, both `cmake` and `magick` must be included in your safe tools list.
829+
*Any* tool used by the build process must be included in the `xbuild-tools` list, not just tools that cibuildwheel will invoke directly. For example, if your build invokes `cmake`, and the `cmake` script invokes `magick` to perform some image transformations, both `cmake` and `magick` must be included in your safe tools list.
830830

831831
Platform-specific environment variables are also available on platforms that use cross-platform environment isolation:<br/>
832832
`CIBW_XBUILD_TOOLS_IOS`
@@ -1297,7 +1297,7 @@ Using `{package}` or `{project}` used to be required, but since cibuildwheel
12971297
use relative paths in your test command, and they will be relative to the
12981298
project root.
12991299

1300-
Alternatively, you can use the [`test_sources`](#test-sources) setting to
1300+
Alternatively, you can use the [`test-sources`](#test-sources) setting to
13011301
create a temporary folder populated with a specific subset of project files to
13021302
run your test suite.
13031303

@@ -1456,7 +1456,7 @@ Platform-specific environment variables are also available:<br/>
14561456
```
14571457

14581458

1459-
### `test_requires` {: #test-requires env-var toml}
1459+
### `test-requires` {: #test-requires env-var toml}
14601460
> Install Python dependencies before running the tests
14611461
14621462
Space-separated list of dependencies required for running the tests.
@@ -1469,7 +1469,7 @@ Platform-specific environment variables are also available:<br/>
14691469
!!! tab examples "pyproject.toml"
14701470

14711471
```toml
1472-
# Install pytest before running CIBW_TEST_COMMAND
1472+
# Install pytest before running test-command
14731473
[tool.cibuildwheel]
14741474
test-requires = "pytest"
14751475

@@ -1565,7 +1565,7 @@ Platform-specific environment variables are also available:<br/>
15651565
### `test-skip` {: #test-skip env-var toml}
15661566
> Skip running tests on some builds
15671567
1568-
This will skip testing on any identifiers that match the given skip patterns (see [`CIBW_SKIP`](#build-skip)). This can be used to mask out tests for wheels that have missing dependencies upstream that are slow or hard to build, or to skip slow tests on emulated architectures.
1568+
This will skip testing on any identifiers that match the given skip patterns (see [`skip`](#build-skip)). This can be used to mask out tests for wheels that have missing dependencies upstream that are slow or hard to build, or to skip slow tests on emulated architectures.
15691569

15701570
With macOS `universal2` wheels, you can also skip the individual archs inside the wheel using an `:arch` suffix. For example, `cp39-macosx_universal2:x86_64` or `cp39-macosx_universal2:arm64`.
15711571

@@ -1639,6 +1639,7 @@ Platform-specific environment variables are also available:<br/>
16391639
## Debugging
16401640

16411641
### `CIBW_DEBUG_KEEP_CONTAINER` {: #debug-keep-container env-var}
1642+
> Keep the container after running for debugging.
16421643
16431644
Enable this flag to keep the container around for inspection after a build. This
16441645
option is provided for debugging purposes only.

0 commit comments

Comments
 (0)