Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1560 Update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
elBoberido committed Aug 4, 2022
1 parent 7bc3872 commit e495d7a
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions doc/website/release-notes/iceoryx-unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
- Remove AtomicRelocatablePointer [\#1512](https://github.com/eclipse-iceoryx/iceoryx/issues/1512)
- `SignalHandler` returns an `expected` in `registerSignalHandler` [\#1196](https://github.com/eclipse-iceoryx/iceoryx/issues/1196)
- Remove the unused `PosixRights` struct [\#1556](https://github.com/eclipse-iceoryx/iceoryx/issues/1556)
- Cleanup helplets [\#1560](https://github.com/eclipse-iceoryx/iceoryx/issues/1560)

**Workflow:**

Expand Down Expand Up @@ -261,3 +262,50 @@
// perform error handling
}
```

14. Remove `forEach` from helplets
```cpp
// before
iox::cxx::forEach(container, [&] (element) { /* do stuff with element */ });

// after
for (const auto& element: container) { /* do stuff with element */ }
```

15. Remove `enumTypeAsUnderlyingType`
```cpp
constexpr const char* SOME_ENUM_STRINGS[] = {"FOO", "BAR"};

// before
std::cout << SOME_ENUM_STRINGS[iox::cxx::enumTypeAsUnderlyingType(someEnum)] << std::endl;

// after
std::cout << SOME_ENUM_STRINGS[static_cast<uint64_t>(someEnum)] << std::endl;
```

16. Remove `convertEnumToString`
```cpp
constexpr const char* SOME_ENUM_STRINGS[] = {"FOO", "BAR"};

// before
std::cout << iox::cxx::convertEnumToString(SOME_ENUM_STRINGS, someEnum] << std::endl;

// after
std::cout << SOME_ENUM_STRINGS[static_cast<uint64_t>(someEnum)] << std::endl;
```

17. Replace `strlen2` with more generic `arrayCapacity`
```cpp
constexpr const char LITERAL1[] {"FOO"};
constexpr const char LITERAL2[20] {"BAR"};
constexpr const uint32_t ARRAY[42] {};

// before
std::cout << iox::cxx::strlen2(LITERAL1) << std::endl; // prints 3
std::cout << iox::cxx::strlen2(LITERAL2) << std::endl; // prints 19

// after
std::cout << arrayCapacity(LITERAL1) << std::endl; // prints 4
std::cout << arrayCapacity(LITERAL2) << std::endl; // prints 20
std::cout << arrayCapacity(ARRAY) << std::endl; // prints 42
```

0 comments on commit e495d7a

Please sign in to comment.