Skip to content

Commit 8c99ffd

Browse files
iox-#1295 LogLevel and other minor fixes in release notes
1 parent 1a5b82d commit 8c99ffd

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

doc/website/release-notes/iceoryx-unreleased.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# iceoryx v3.0.0 (UNRELEASED)
1+
# iceoryx vx.x.x (UNRELEASED)
22

3-
## [v3.0.0](https://github.com/eclipse-iceoryx/iceoryx/tree/vx.x.x) (2025-03-16)
3+
## [vx.x.x](https://github.com/eclipse-iceoryx/iceoryx/tree/vx.x.x) (2025-xx-xx)
44

55
[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/vx.x.x...vx.x.x)
66

@@ -318,7 +318,7 @@
318318
iox::optional<iox::NamedSemaphore> semaphore;
319319
auto result = iox::NamedSemaphoreBuilder()
320320
.name("mySemaphoreName")
321-
.openMode(iox::OpenMode::OPEN_OR_CREATE)
321+
.openMode(iox::OpenMode::OpenOrCreate)
322322
.permissions(iox::perms::owner_all)
323323
.initialValue(0U)
324324
.create(semaphore);
@@ -788,13 +788,13 @@
788788

789789
| before | after |
790790
|:----------:|:-------:|
791-
| `kOff` | `OFF` |
792-
| `kFatal` | `FATAL` |
793-
| `kError` | `ERROR` |
794-
| `kWarn` | `WARN` |
795-
| `kInfo` | `INFO` |
796-
| `kDebug` | `DEBUG` |
797-
| `kVerbose` | `TRACE` |
791+
| `kOff` | `Off` |
792+
| `kFatal` | `Fatal` |
793+
| `kError` | `Error` |
794+
| `kWarn` | `Warn` |
795+
| `kInfo` | `Info` |
796+
| `kDebug` | `Debug` |
797+
| `kVerbose` | `Trace` |
798798

799799
In the C binding the `Iceoryx_LogLevel_Verbose` changed to `Iceoryx_LogLevel_Trace`.
800800

@@ -813,9 +813,9 @@
813813
// after
814814
#include "iox/logging.hpp"
815815

816-
iox::log::Logger::init(iox::log::LogLevel::INFO);
816+
iox::log::Logger::init(iox::log::LogLevel::Info);
817817

818-
IOX_LOG(INFO, "Hello World " << 42);
818+
IOX_LOG(Info, "Hello World " << 42);
819819
```
820820

821821
31. Setting the default log level changed
@@ -829,7 +829,7 @@
829829
// after
830830
#include "iox/logging.hpp"
831831

832-
iox::log::Logger::init(iox::log::LogLevel::ERROR);
832+
iox::log::Logger::init(iox::log::LogLevel::Error);
833833
```
834834

835835
Please look at the logger design document for more details like setting the log level via environment variables.
@@ -841,7 +841,7 @@
841841
logger.SetLogLevel(); // directly on the instance
842842

843843
// after
844-
iox::log::Logger::setLogLevel(iox::log::LogLevel::DEBUG);
844+
iox::log::Logger::setLogLevel(iox::log::LogLevel::Debug);
845845
```
846846

847847
33. Using the logger in libraries is massively simplified
@@ -901,7 +901,7 @@
901901
{
902902
void myFunc()
903903
{
904-
IOX_LOG(INFO, "Hello World " << 42);
904+
IOX_LOG(Info, "Hello World " << 42);
905905
}
906906
}
907907
```
@@ -910,12 +910,12 @@
910910

911911
| before | after |
912912
|:---------------------------:|:---------------------------:|
913-
| `LogFatal() << "x" << 42` | `IOX_LOG(FATAL, "x" << 42)` |
914-
| `LogError() << "x" << 42` | `IOX_LOG(ERROR, "x" << 42)` |
915-
| `LogWarn() << "x" << 42` | `IOX_LOG(WARN, "x" << 42)` |
916-
| `LogInfo() << "x" << 42` | `IOX_LOG(INFO, "x" << 42)` |
917-
| `LogDebug() << "x" << 42` | `IOX_LOG(DEBUG, "x" << 42)` |
918-
| `LogVerbose() << "x" << 42` | `IOX_LOG(TRACE, "x" << 42)` |
913+
| `LogFatal() << "x" << 42` | `IOX_LOG(Fatal, "x" << 42)` |
914+
| `LogError() << "x" << 42` | `IOX_LOG(Error, "x" << 42)` |
915+
| `LogWarn() << "x" << 42` | `IOX_LOG(Warn, "x" << 42)` |
916+
| `LogInfo() << "x" << 42` | `IOX_LOG(Info, "x" << 42)` |
917+
| `LogDebug() << "x" << 42` | `IOX_LOG(Debug, "x" << 42)` |
918+
| `LogVerbose() << "x" << 42` | `IOX_LOG(Trace, "x" << 42)` |
919919

920920
35. Logger formatting changed
921921

@@ -926,10 +926,10 @@
926926
LogInfo() << iox::log::RawBuffer(buf);
927927

928928
// after
929-
IOX_LOG(INFO, iox::log::hex(42));
930-
IOX_LOG(INFO, iox::log::oct(37));
931-
IOX_LOG(INFO, iox::log::bin(73));
932-
IOX_LOG(INFO, iox::log::raw(buf));
929+
IOX_LOG(Info, iox::log::hex(42));
930+
IOX_LOG(Info, iox::log::oct(37));
931+
IOX_LOG(Info, iox::log::bin(73));
932+
IOX_LOG(Info, iox::log::raw(buf));
933933
```
934934

935935
36. Creating an instance of `LogStream` does not work anymore
@@ -946,7 +946,7 @@
946946
stream.Flush();
947947

948948
// after
949-
IOX_LOG(INFO, [] (auto& stream) -> auto& {
949+
IOX_LOG(Info, [] (auto& stream) -> auto& {
950950
stream << "fibonacci: "
951951
for(auto fib : {1, 1, 2, 3, 5, 8})
952952
{
@@ -1016,7 +1016,7 @@
10161016
#include "iceoryx_hoofs/testing/testing_logger.hpp"
10171017

10181018
sut.methodCallWithLogOutput();
1019-
if (iox::testing::TestingLogger::doesLoggerSupportLogLevel(iox::log::LogLevel::ERROR))
1019+
if (iox::testing::TestingLogger::doesLoggerSupportLogLevel(iox::log::LogLevel::Error))
10201020
{
10211021
auto logMessages = iox::testing::TestingLogger::getLogMessages();
10221022
ASSERT_THAT(logMessages.size(), Eq(1U));

0 commit comments

Comments
 (0)