Skip to content

Commit 976f6c2

Browse files
committed
[#154] Add release notes
1 parent 45b1608 commit 976f6c2

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

doc/release-notes/iceoryx2-unreleased.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
NOTE: Add new entries sorted by issue number to minimize the possibility of
1111
conflicts when merging.
1212
-->
13+
* Separate log crate into front-end API and backend logger implementation crates
14+
[#154](https://github.com/eclipse-iceoryx/iceoryx2/issues/154)
1315
* Android proof of concept with `local` communication
1416
[#416](https://github.com/eclipse-iceoryx/iceoryx2/issues/416)
1517
* C, C++, and Python language bindings for blackboard
@@ -120,6 +122,30 @@ CMake package.
120122

121123
### API Breaking Changes
122124

125+
1. **Rust:** Require logger backend to be set at runtime
126+
127+
```rust
128+
// old - logger automatically set based on feature flags
129+
use iceoryx2::prelude::*;
130+
131+
fn main() {
132+
set_log_level_from_env_or(LogLevel::Info);
133+
info!("Some log message");
134+
}
135+
136+
// new - logger must be explicitly set at runtime
137+
use iceoryx2::prelude::*;
138+
use iceoryx2_loggers::console::Logger;
139+
140+
static LOGGER: Logger = Logger::new();
141+
142+
fn main() {
143+
set_logger(&LOGGER);
144+
set_log_level_from_env_or(LogLevel::Info);
145+
info!("Some log message");
146+
}
147+
```
148+
123149
1. **Rust:** Replaced the `FixedSizeVec` with the `StaticVec`
124150

125151
```rust
@@ -134,7 +160,7 @@ CMake package.
134160
let my_vec = StaticVec::<MyType, VEC_CAPACITY>::new();
135161
```
136162

137-
2. **Rust:** Replaced `Vec` with the `PolymorphicVec`
163+
1. **Rust:** Replaced `Vec` with the `PolymorphicVec`
138164

139165
```rust
140166
// old
@@ -149,7 +175,7 @@ CMake package.
149175
let my_vec = PolymorphicVec::<MyType>::new(my_stateful_allocator, vec_capacity)?;
150176
```
151177

152-
3. **Rust:** Replaced the `FixedSizeByteString` with the `StaticString`
178+
1. **Rust:** Replaced the `FixedSizeByteString` with the `StaticString`
153179

154180
```rust
155181
// old
@@ -163,7 +189,7 @@ CMake package.
163189
let my_str = StaticString::<CAPACITY>::new();
164190
```
165191

166-
4. **C++:** Remove `operator*` and `operator->` from `ActiveRequest`,
192+
1. **C++:** Remove `operator*` and `operator->` from `ActiveRequest`,
167193
`PendingResponse`, `RequestMut`, `RequestMutUninit`, `Response`,
168194
`ResponseMut`, `Sample`, `SampleMut`, `SampleMutUninit` since these can
169195
easily lead to confusion and bugs when used in combination with `optional`
@@ -192,7 +218,7 @@ CMake package.
192218
std::cout << sample.payload() << std::endl;
193219
```
194220

195-
5. **Rust:** Changed the signature for Tunnel creation to take a concrete
221+
1. **Rust:** Changed the signature for Tunnel creation to take a concrete
196222
backend implementation
197223

198224
```rust
@@ -213,5 +239,5 @@ CMake package.
213239
Tunnel::<Service, Backend>::create(&tunnel_config, &iceoryx_config, &backend_config).unwrap();
214240
```
215241

216-
6. Removed the `cdr` serializer from `iceoryx2-cal`, it is recommended to
242+
1. Removed the `cdr` serializer from `iceoryx2-cal`, it is recommended to
217243
switch to the `postcard` serializer in its place

0 commit comments

Comments
 (0)