Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Christoph Fröhlich <christophfroehlich@users.noreply.github.com>
  • Loading branch information
bmagyar and christophfroehlich committed Sep 25, 2024
1 parent 4c63d28 commit 50c7b9e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,5 @@ Custom export of Command-/StateInterfaces
In case the default implementation (``on_export_command_interfaces()`` or ``on_export_state_interfaces()`` ) for exporting the ``Command-/StateInterfaces`` is not enough you can override them. You should however consider the following things:

* If you want to have unlisted interfaces available you need to call the ``export_unlisted_command_interfaces()`` or ``export_unlisted_state_interfaces()`` and add them to the ``unlisted_command_interfaces_`` or ``unlisted_state_interfaces_``.
* Don't forget to store the created ``Command-/StateInterfaces`` internally as you only return ``std::shared_ptr``s and the resource manager will not provide access to the created ``Command-/StateInterface``s for the hardware. So you must take care of storing them yourself.
* Don't forget to store the created ``Command-/StateInterfaces`` internally as you only return ``std::shared_ptr`` and the resource manager will not provide access to the created ``Command-/StateInterface`` for the hardware. So you must take care of storing them yourself.
* Names must be unique!

0 comments on commit 50c7b9e

Please sign in to comment.