From efeabf27f5a0857aa1d958d695ad09a38486de6d Mon Sep 17 00:00:00 2001 From: Mike Karlesky Date: Tue, 7 May 2024 14:54:12 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Added=20logging=20and=20decorato?= =?UTF-8?q?rs=20to=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/CeedlingPacket.md | 10 +++++++--- docs/Changelog.md | 12 ++++++++---- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/CeedlingPacket.md b/docs/CeedlingPacket.md index f2978c2b..226c759e 100644 --- a/docs/CeedlingPacket.md +++ b/docs/CeedlingPacket.md @@ -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` diff --git a/docs/Changelog.md b/docs/Changelog.md index ce62e9f3..2d6639a0 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -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 @@ -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 @@ -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.