Skip to content

Minor fixes in release notes #2419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mossmaurice merged 1 commit into from
Feb 24, 2025
Merged

Minor fixes in release notes #2419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions doc/website/release-notes/iceoryx-unreleased.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# iceoryx v3.0.0 (UNRELEASED)
# iceoryx vx.x.x (UNRELEASED)

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

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

Expand Down Expand Up @@ -318,7 +318,7 @@
iox::optional<iox::NamedSemaphore> semaphore;
auto result = iox::NamedSemaphoreBuilder()
.name("mySemaphoreName")
.openMode(iox::OpenMode::OPEN_OR_CREATE)
.openMode(iox::OpenMode::OpenOrCreate)
.permissions(iox::perms::owner_all)
.initialValue(0U)
.create(semaphore);
Expand Down Expand Up @@ -788,13 +788,13 @@

| before | after |
|:----------:|:-------:|
| `kOff` | `OFF` |
| `kFatal` | `FATAL` |
| `kError` | `ERROR` |
| `kWarn` | `WARN` |
| `kInfo` | `INFO` |
| `kDebug` | `DEBUG` |
| `kVerbose` | `TRACE` |
| `kOff` | `Off` |
| `kFatal` | `Fatal` |
| `kError` | `Error` |
| `kWarn` | `Warn` |
| `kInfo` | `Info` |
| `kDebug` | `Debug` |
| `kVerbose` | `Trace` |

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

Expand All @@ -813,9 +813,9 @@
// after
#include "iox/logging.hpp"

iox::log::Logger::init(iox::log::LogLevel::INFO);
iox::log::Logger::init(iox::log::LogLevel::Info);

IOX_LOG(INFO, "Hello World " << 42);
IOX_LOG(Info, "Hello World " << 42);
```

31. Setting the default log level changed
Expand All @@ -829,7 +829,7 @@
// after
#include "iox/logging.hpp"

iox::log::Logger::init(iox::log::LogLevel::ERROR);
iox::log::Logger::init(iox::log::LogLevel::Error);
```

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

// after
iox::log::Logger::setLogLevel(iox::log::LogLevel::DEBUG);
iox::log::Logger::setLogLevel(iox::log::LogLevel::Debug);
```

33. Using the logger in libraries is massively simplified
Expand Down Expand Up @@ -901,7 +901,7 @@
{
void myFunc()
{
IOX_LOG(INFO, "Hello World " << 42);
IOX_LOG(Info, "Hello World " << 42);
}
}
```
Expand All @@ -910,12 +910,12 @@

| before | after |
|:---------------------------:|:---------------------------:|
| `LogFatal() << "x" << 42` | `IOX_LOG(FATAL, "x" << 42)` |
| `LogError() << "x" << 42` | `IOX_LOG(ERROR, "x" << 42)` |
| `LogWarn() << "x" << 42` | `IOX_LOG(WARN, "x" << 42)` |
| `LogInfo() << "x" << 42` | `IOX_LOG(INFO, "x" << 42)` |
| `LogDebug() << "x" << 42` | `IOX_LOG(DEBUG, "x" << 42)` |
| `LogVerbose() << "x" << 42` | `IOX_LOG(TRACE, "x" << 42)` |
| `LogFatal() << "x" << 42` | `IOX_LOG(Fatal, "x" << 42)` |
| `LogError() << "x" << 42` | `IOX_LOG(Error, "x" << 42)` |
| `LogWarn() << "x" << 42` | `IOX_LOG(Warn, "x" << 42)` |
| `LogInfo() << "x" << 42` | `IOX_LOG(Info, "x" << 42)` |
| `LogDebug() << "x" << 42` | `IOX_LOG(Debug, "x" << 42)` |
| `LogVerbose() << "x" << 42` | `IOX_LOG(Trace, "x" << 42)` |

35. Logger formatting changed

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

// after
IOX_LOG(INFO, iox::log::hex(42));
IOX_LOG(INFO, iox::log::oct(37));
IOX_LOG(INFO, iox::log::bin(73));
IOX_LOG(INFO, iox::log::raw(buf));
IOX_LOG(Info, iox::log::hex(42));
IOX_LOG(Info, iox::log::oct(37));
IOX_LOG(Info, iox::log::bin(73));
IOX_LOG(Info, iox::log::raw(buf));
```

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

// after
IOX_LOG(INFO, [] (auto& stream) -> auto& {
IOX_LOG(Info, [] (auto& stream) -> auto& {
stream << "fibonacci: "
for(auto fib : {1, 1, 2, 3, 5, 8})
{
Expand Down Expand Up @@ -1016,7 +1016,7 @@
#include "iceoryx_hoofs/testing/testing_logger.hpp"

sut.methodCallWithLogOutput();
if (iox::testing::TestingLogger::doesLoggerSupportLogLevel(iox::log::LogLevel::ERROR))
if (iox::testing::TestingLogger::doesLoggerSupportLogLevel(iox::log::LogLevel::Error))
{
auto logMessages = iox::testing::TestingLogger::getLogMessages();
ASSERT_THAT(logMessages.size(), Eq(1U));
Expand Down
Loading