Clarify wording in MPS reader documentation

Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
Hanno Becker 2021-02-08 08:19:16 +00:00
parent a408c1719c
commit 8fc107c9fb

View file

@ -146,7 +146,8 @@ struct mbedtls_mps_reader
* Must be 0 if \c frag == \c NULL. */ * Must be 0 if \c frag == \c NULL. */
mbedtls_mps_stored_size_t commit; mbedtls_mps_stored_size_t commit;
/*!< The offset of the last commit, relative /*!< The offset of the last commit, relative
* to the first byte in the accumulator. * to the first byte in the fragment or, if
* present, the accumulator.
* This is only used when the reader is in * This is only used when the reader is in
* consuming mode, i.e. \c frag != \c NULL; * consuming mode, i.e. \c frag != \c NULL;
* otherwise, its value is \c 0. */ * otherwise, its value is \c 0. */