Skip to content

Commit

Permalink
📝 Added logging and decorators to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkarlesky committed May 7, 2024
1 parent 7c858ec commit efeabf2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
10 changes: 7 additions & 3 deletions docs/CeedlingPacket.md
Original file line number Diff line number Diff line change
Expand Up @@ -2183,9 +2183,13 @@ migrated to the `:test_build` and `:release_build` sections.
So, by default this feature is disabled on problematic platforms while
enabled on others.

_Note:_ If you find a monospaced font that provides emojis, etc. and
works with Windows’ command prompt, you can (1) Install the font (2)
change your command prompt’s font (3) set this option to `:all`.
_Notes:_
* A complementary environment variable `CEEDLING_DECORATORS` takes
precedence over the project configuration setting. It merely forces
decorators on or off with a `true` (`1`) or `false` (`0`) string value.
* If you find a monospaced font that provides emojis, etc. and
works with Windows’ command prompt, you can (1) Install the font (2)
change your command prompt’s font (3) set this option to `:all`.

**Default**: `:auto`

Expand Down
12 changes: 8 additions & 4 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This changelog is complemented by two other documents:

---

# [1.0.0 pre-release] — 2024-04-22
# [1.0.0 pre-release] — 2024-05-07

## 🌟 Added

Expand Down Expand Up @@ -85,11 +85,11 @@ A community member submitted an [HTML report generation plugin](https://github.c

### Improved Segfault Handling

Segmentation faults are now reported as failures instead of an error and given as fine of detail as possible for the current feature set. See the docs on `:backtrace` for more!
Segmentation faults are now reported as failures instead of an error and given as fine of detail as possible for the current feature set. See the project configuration file documentation on `:project``:use_backtrace` for more!

### Pretty streamed output
### Pretty logging output

The output of Ceedling now optionally includes emoji and color. Ceedling will attempt to determine if your platform supports it. You can use `use_decorators` to force the feature on or off.
Ceedling logging now optionally includes emoji and nice Unicode characters . Ceedling will attempt to determine if your platform supports it. You can use an environment variable `CEEDLING_DECORATORS` or your project configuration `:project``:use_decorators` to force the feature on or off.

## 💪 Fixed

Expand Down Expand Up @@ -169,6 +169,10 @@ Documentation on Mixins and the new options for loading a project configuration
1. Additional events have been added for test preprocessing steps (the popular and useful [`command_hooks` plugin](plugins/command_hooks/README.md) has been updated accordingly).
1. Built-in plugins have been updated for thread-safety as Ceedling is now able to execute builds with multiple threads.

### Logging improvements

Logging messages are more useful. A variety of logging messages have been added throughout Ceedling builds. Message labels (e.g. `ERROR:`) are now applied automatically). Exception handling is now centralized and significantly cleans up exception messages (backtraces are available with debug verbosity).

### Exit code options for test suite failures

Be default Ceedling terminates with an exit code of `1` when a build succeeds but unit tests fail.
Expand Down

0 comments on commit efeabf2

Please sign in to comment.