Skip to content

Commit d170201

Browse files
committed
Add inline documentation for build -C
1 parent 2c2d953 commit d170201

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

spin/cmds/meson.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,8 @@ def build(
263263
):
264264
"""🔧 Build package with Meson/ninja
265265
266-
The package is installed to `build-install`.
266+
The package is installed to `build-install` (unless a different
267+
build directory is specified with `-C`).
267268
268269
MESON_ARGS are passed through e.g.:
269270
@@ -277,6 +278,17 @@ def build(
277278
or set CFLAGS appropriately:
278279
279280
CFLAGS="-O0 -g" spin build
281+
282+
Build into a different build/build-install directory:
283+
284+
spin build -C build-for-feature-x
285+
286+
This feature is useful in combination with a shell alias, e.g.:
287+
288+
$ alias spin-clang="spin -C build-clang"
289+
290+
Which can then be used to build (`spin-clang build`), to test (`spin-clang test ...`), etc.
291+
280292
"""
281293
install_dir = _get_install_dir(build_dir)
282294
cfg = get_config()

0 commit comments

Comments
 (0)