Skip to content

Commit

Permalink
pw_rpc: Update config name in documentation
Browse files Browse the repository at this point in the history
`PW_RPC_ENCODING_BUFFER_SIZE` is called
`PW_RPC_ENCODING_BUFFER_SIZE_BYTES`, update the documentation.

Change-Id: Ia243d916dd663053b83d522ee8c8c7a65f1e1a00
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/93980
Pigweed-Auto-Submit: Alex Deymo <[email protected]>
Commit-Queue: Auto-Submit <[email protected]>
Reviewed-by: Wyatt Hepler <[email protected]>
  • Loading branch information
deymo authored and CQ Bot Account committed May 10, 2022
1 parent 7da0b71 commit afae658
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pw_rpc/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1252,7 +1252,7 @@ minimal overhead, ``pw_rpc`` uses a single, global mutex (when

Because ``pw_rpc`` uses a global mutex, it also uses a global buffer to encode
outgoing packets. The size of the buffer is set with
``PW_RPC_ENCODING_BUFFER_SIZE``, which defaults to 512 B.
``PW_RPC_ENCODING_BUFFER_SIZE_BYTES``, which defaults to 512 B.

Users of ``pw_rpc`` must implement the :cpp:class:`pw::rpc::ChannelOutput`
interface.
Expand Down

0 comments on commit afae658

Please sign in to comment.