From afae6586f4e863caa3ef4509818839c2998b1b4f Mon Sep 17 00:00:00 2001 From: Alex Deymo Date: Mon, 9 May 2022 20:41:44 +0200 Subject: [PATCH] pw_rpc: Update config name in documentation `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 Commit-Queue: Auto-Submit Reviewed-by: Wyatt Hepler --- pw_rpc/docs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pw_rpc/docs.rst b/pw_rpc/docs.rst index 4906addc45..e58960a165 100644 --- a/pw_rpc/docs.rst +++ b/pw_rpc/docs.rst @@ -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.