doc: zbus: update documentation with changes for 3.5 #63674
Conversation
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
6020e3f to
dbd99e3
Compare
rodrigopex
requested review from
kartben and
gmarull
and removed request for
nashif and
carlescufi
|
@kartben, I would like to share the Figma file I used to draw the bus diagrams with people. The files are here: https://www.figma.com/community/file/1292866458780627559/zbus-diagram-assets. What do you think is the best way to do that? |
I would add a comment at the top of the index.rst |
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
5 times, most recently
from
0bb2c7f to
c6e08bc
Compare
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
c6e08bc to
9b75c24
Compare
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
9b75c24 to
a450f21
Compare
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
0164a96 to
8c6a3db
Compare
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
2 times, most recently
from
06ea6a5 to
9a8f009
Compare
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
9a8f009 to
922f3e9
Compare
There was a problem hiding this comment.
Great stuff @rodrigopex! I based my review mostly on the looks of the final rendered page rather than looking specifically at the diff -- spotted a few formatting style issues.
doc/services/zbus/index.rst
Outdated
| * :zephyr:code-sample:`zbus-hello-world` illustrates the code used above in action; | ||
| * :zephyr:code-sample:`zbus-work-queue` shows how to define and use different kinds of observers. Note there is an example of using a work queue instead of executing the listener as an execution option; | ||
| * :zephyr:code-sample:`zbus-dyn-channel` demonstrates how to use dynamically allocated exchanging data in zbus; | ||
| * :zephyr:code-sample:`zbus-uart-bridge` shows an example of sending the operation of the channel to a host via serial; | ||
| * :zephyr:code-sample:`zbus-remote-mock` illustrates how to implement an external mock (on the host) to send and receive messages to and from the bus. | ||
| * :zephyr:code-sample:`zbus-runtime-obs-registration` illustrates a way of using the runtime observer registration feature; | ||
| * :zephyr:code-sample:`zbus-work-queue` shows how to define and use different kinds of observers. | ||
| Note there is an example of using a work queue instead of executing the listener as an execution | ||
| option; | ||
| * :zephyr:code-sample:`zbus-msg-subscriber` illustrates how to use message subscribers. | ||
| * :zephyr:code-sample:`zbus-dyn-channel` demonstrates how to use dynamically allocated exchanging | ||
| data in zbus; | ||
| * :zephyr:code-sample:`zbus-uart-bridge` shows an example of sending the operation of the channel to | ||
| a host via serial; | ||
| * :zephyr:code-sample:`zbus-remote-mock` illustrates how to implement an external mock (on the host) | ||
| to send and receive messages to and from the bus. | ||
| * :zephyr:code-sample:`zbus-runtime-obs-registration` illustrates a way of using the runtime | ||
| observer registration feature; | ||
| * :zephyr:code-sample:`zbus-confirmed-channel` implements a way of implement confirmed channel only | ||
| with subscribers. | ||
| * :zephyr:code-sample:`zbus-benchmark` implements a benchmark with different combinations of inputs. |
There was a problem hiding this comment.
btw it makes me realize that it would maybe make sense to provide a Sphinx directive that outputs the equivalent of what shows up in the API reference, as this could be useful to list samples anywhere.
There was a problem hiding this comment.
There was a problem hiding this comment.
Sorry I should have been clearer, and I think it's fine if you live it as-is for now. I was mostly talking to myself and thinking that I should add to the code-sample sphinx extension a way to easily output the list of samples related to a specific set of doxygengroups, as it might be useful in situations like yours.
That being said, this section pretty much "paraphrases" the list of samples that also already show up automatically in the API reference, mere lines below, so if you think that list is enough and easy enough to not miss for folks, then maybe just drop your Samples section altogether (but again, also 100% fine with me if you'd like to keep it!)
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
922f3e9 to
b18a425
Compare
There was a problem hiding this comment.
@kartben, I changed most of your requests. The only thing I still need to change is the samples. I'm just waiting for your feedback to remove that or not. But the rest is ok.
Add documentation for the new way to storage observers, the message subscribers, and the confirmed message sample. Signed-off-by: Rodrigo Peixoto <[email protected]>
ZBus had one break change related to the runtime observers' configuration, and the VDED delivery sequence has changed. This commit adds entries on the migration guide about the mentioned changes. Signed-off-by: Rodrigo Peixoto <[email protected]>
rodrigopex
force-pushed
the
zbus_doc_3version5
branch
from
b18a425 to
a3eaa77
Compare
Add documentation for the new way to allocate observers, the message subscribers, and the confirmed message sample. And
add the breaking changes to the migration guide.
Structural changes: