From 17793d6fc69e52ac257d82d42482504e375b4c53 Mon Sep 17 00:00:00 2001 From: David Rogers Date: Fri, 5 Feb 2021 03:29:02 -0800 Subject: pw_blob_store: Add size report Add size reports for both standard buffered blob and deferred writer blob store Change-Id: If8688195f8865c5accc1ec86a9ec57c7b1faecbb Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/31840 Reviewed-by: Alexei Frolov Commit-Queue: David Rogers --- pw_blob_store/docs.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'pw_blob_store/docs.rst') diff --git a/pw_blob_store/docs.rst b/pw_blob_store/docs.rst index a84a22e94..906d94295 100644 --- a/pw_blob_store/docs.rst +++ b/pw_blob_store/docs.rst @@ -10,7 +10,7 @@ system. Write and read are only done using the BlobWriter and BlobReader classes. -Once a blob write is closed, reopening followed by a Discard(), Write(), or +Once a blob write is closed, reopening for write followed by a Discard(), Write(), or Erase() will discard the previous blob. Write blob: @@ -26,5 +26,12 @@ Read blob: BlobReader::GetMemoryMappedBlob(). 3) BlobReader::Close(). +Size report +----------- +The following size report showcases the memory usage of the blob store. + +.. include:: blob_size + + .. note:: The documentation for this module is currently incomplete. -- cgit v1.2.3