Skip to content

Commit dcbe0f1

Browse files
authored
CC_SHELL_ESCAPED_FLAGS: improve docs (#1183)
1 parent b0e44c7 commit dcbe0f1

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/lib.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,10 @@
8484
//! * `CC_ENABLE_DEBUG_OUTPUT` - if set, compiler command invocations and exit codes will
8585
//! be logged to stdout. This is useful for debugging build script issues, but can be
8686
//! overly verbose for normal use.
87-
//! * `CC_SHELL_ESCAPED_FLAGS` - if set, *FLAGS will be parsed as if they were shell
88-
//! arguments, similar to `make` and `cmake`. For example, `CFLAGS='a "b c" d\ e'` will
89-
//! be parsed as `["a", "b", "c", "d", "e"]` instead of `["a", "\"b", "c\", "d\\", "e"]`
87+
//! * `CC_SHELL_ESCAPED_FLAGS` - if set, `*FLAGS` will be parsed as if they were shell
88+
//! arguments (similar to `make` and `cmake`) rather than splitting them on each space.
89+
//! For example, with `CFLAGS='a "b c"'`, the compiler will be invoked with 2 arguments -
90+
//! `a` and `b c` - rather than 3: `a`, `"b` and `c"`.
9091
//! * `CXX...` - see [C++ Support](#c-support).
9192
//!
9293
//! Furthermore, projects using this crate may specify custom environment variables

0 commit comments

Comments
 (0)