Skip to content

Commit

Permalink
iox-#1533 Update release notes and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elBoberido committed Sep 6, 2023
1 parent a704944 commit 03da6d3
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
1 change: 0 additions & 1 deletion doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ skinparam frame {
' @todo #539
' RouDi split, separate files and namespaces for static/dynamic discovery
' Implement exported libraries (add_library in iceoryx_posh/CMakeLists.txt)
' RouDiEnvironment shall not be in roudi namespace, but in testing

header Eclipse iceoryx component overview

Expand Down
3 changes: 1 addition & 2 deletions doc/website/images/iceoryx_components_diagram_v3_0_0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions doc/website/release-notes/iceoryx-unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@
- Better align `iox::expected` with `std::expected` [\#1969](https://github.com/eclipse-iceoryx/iceoryx/issues/1969)
- Use logger for "RouDi is ready for clients" message [\#1994](https://github.com/eclipse-iceoryx/iceoryx/issues/1994)
- Speed up posh tests [#1030](https://github.com/eclipse-iceoryx/iceoryx/issues/1030)
- Roudi Environment independent from Googletest [#1533](https://github.com/eclipse-iceoryx/iceoryx/issues/1533)

**Workflow:**

Expand Down Expand Up @@ -1177,3 +1178,33 @@
};

```

53. `iox::roudi::RouDiEnvironment` is moved to `iox::roudi_env::RouDiEnv` and in a separate library

There is still an alias on the old location with a deprecation warning. The API also changed a bit.
```cpp
// before
#include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
iox::roudi::RouDiEnvironment roudiEnv{/*config*/};

// after
#include "iceoryx_posh/roudi_env/roudi_environment.hpp"
iox::roudi_enf::RouDiEnv roudiEnv{/*config*/};


// before
roudiEnv.InterOpWait();

// after
roudiEnv.triggerDiscoveryLoopAndWaitToFinish();


// before
SetInterOpWaitingTime(/*chrono*/);

// after
setDiscoveryLoopWaitToFinishTimeout(/*units::Duration*/);

```

It is now also possible to directly link to `iceoryx_posh::iceoryx_posh_roudi_env` which has no dependency to gTest.

0 comments on commit 03da6d3

Please sign in to comment.