diff options
| author | David Rogers <davidrogers@google.com> | 2021-02-05 03:29:02 -0800 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2021-03-05 06:52:46 +0000 |
| commit | 17793d6fc69e52ac257d82d42482504e375b4c53 (patch) | |
| tree | 5aeca3e130d6c2571ddd3d5b0e6a0bb79a68a0cb /pw_blob_store/docs.rst | |
| parent | ef346b3f2ca94edc7a87eaa766ce08bbccf19431 (diff) | |
| download | pigweed-17793d6fc69e52ac257d82d42482504e375b4c53.tar.gz | |
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 <frolv@google.com>
Commit-Queue: David Rogers <davidrogers@google.com>
Diffstat (limited to 'pw_blob_store/docs.rst')
| -rw-r--r-- | pw_blob_store/docs.rst | 9 |
1 files changed, 8 insertions, 1 deletions
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. |