Skip to content

Commit 29443d3

Browse files
authored
doc: Clarify verbosity options (#1018)
- Changed `cmake.verbose` mention to `build.verbose` - Clarified that CMake configure output is always printed, and does not require any additional options. That's the main usage usually. Signed-off-by: Cristian Le <git@lecris.dev>
1 parent 73ba800 commit 29443d3

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

docs/configuration/index.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,20 @@ options can optionally be prefixed with `skbuild.`, for example
1111

1212
## Verbosity
1313

14+
By default, the CMake configuration output is always shown, but it may be hidden
15+
behind the build frontend setting, e.g. `pip` requires including `-v` argument
16+
in order to display any output.
17+
1418
You can increase the verbosity of the build with two settings - `build.verbose`
15-
is a shortcut for verbose build output, and `logging.level` controls
16-
scikit-build-core's internal logging. An example (with all configuration styles)
17-
of setting both is:
19+
is a shortcut for verbose build output (i.e. `cmake --build ... -v`), and
20+
`logging.level` controls scikit-build-core's internal logging. An example (with
21+
all configuration styles) of setting both is:
1822

1923
````{tab} pyproject.toml
2024

2125
```toml
2226
[tool.scikit-build]
23-
cmake.verbose = true
27+
build.verbose = true
2428
logging.level = "INFO"
2529
```
2630

@@ -32,15 +36,15 @@ logging.level = "INFO"
3236
````{tab} pip
3337
3438
```console
35-
$ pip install . -v --config-settings=cmake.verbose=true --config-settings=logging.level=INFO
39+
$ pip install . -v --config-settings=build.verbose=true --config-settings=logging.level=INFO
3640
```
3741
3842
````
3943
4044
````{tab} build
4145
4246
```console
43-
$ pipx run build --wheel -Ccmake.verbose=true -Clogging.level=INFO
47+
$ pipx run build --wheel -Cbuild.verbose=true -Clogging.level=INFO
4448
```
4549
4650
````
@@ -49,7 +53,7 @@ $ pipx run build --wheel -Ccmake.verbose=true -Clogging.level=INFO
4953
5054
```toml
5155
[tool.cibuildwheel.config-settings]
52-
"cmake.verbose" = true
56+
"build.verbose" = true
5357
"logging.level" = "INFO"
5458
```
5559
@@ -61,20 +65,13 @@ $ pipx run build --wheel -Ccmake.verbose=true -Clogging.level=INFO
6165
6266
6367
```yaml
64-
SKBUILD_CMAKE_VERBOSE: true
68+
SKBUILD_BUILD_VERBOSE: true
6569
SKBUILD_LOGGING_LEVEL: "INFO"
6670
```
6771
6872
6973
````
7074

71-
:::{note}
72-
73-
When using `pip`, make sure you include at least a `-v` argument so that the
74-
verbosity settings above are displayed.
75-
76-
:::
77-
7875
:::{warning}
7976

8077
In general, the environment variable method is intended as an emergency

0 commit comments

Comments
 (0)