Skip to content

Commit c3ba28f

Browse files
bjacotgcopybara-github
authored andcommitted
Add a configuration section in README.md
PiperOrigin-RevId: 545196016
1 parent 14b2d2a commit c3ba28f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,21 @@ fn always_fails() -> Result<()> {
275275
}
276276
```
277277

278+
## Configuration
279+
280+
This library is configurable through environment variables. Since the
281+
configuration does not impact whether a test fails or not but how a failure is
282+
displayed, we recommend setting those variables in the personal
283+
`~/.cargo/config.toml` instead of in the project-scoped `Cargo.toml`.
284+
285+
### Configuration variable list
286+
287+
| Variable name | Description |
288+
| ------------------- | -------------------------------------------------- |
289+
| GTEST_RUST_NO_COLOR | If set to any value, disables ANSI output from the |
290+
: : failure message. This is useful when the failure :
291+
: : description is piped to a file or another process. :
292+
278293
## Contributing Changes
279294

280295
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute

0 commit comments

Comments
 (0)