util/pipe: Fix documentation on spdk_pipe_create
The pipe can now be entirely filled Change-Id: Ib3ec7057224c9239800c1f2877f0441d29c64374 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/17506 Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Mellanox Build Bot Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
This commit is contained in:
parent
818ec14e70
commit
5e29ec96e3
@ -23,9 +23,6 @@ struct spdk_pipe;
|
||||
* Construct a pipe around the given memory buffer. The pipe treats the memory
|
||||
* buffer as a circular ring of bytes.
|
||||
*
|
||||
* The available size for writing will be one less byte than provided. A single
|
||||
* byte must be reserved to distinguish queue full from queue empty conditions.
|
||||
*
|
||||
* \param buf The data buffer that backs this pipe.
|
||||
* \param sz The size of the data buffer.
|
||||
*
|
||||
|
Loading…
Reference in New Issue
Block a user