From b639560594d9dbb570efd67d64877b743fdf9aef Mon Sep 17 00:00:00 2001 From: Jack Cook Date: Fri, 7 Oct 2022 16:20:31 -0500 Subject: [PATCH] Modify `file_size` help doc string (#1401) * Modify `file_size` help doc string * Add note to BLFWriter * Revert "Add note to BLFWriter" This reverts commit 18241acc527b82ee81aa0e546410a158b18ad1d1. * Add in a note about the nuanced file size in help statement based on input from @zariiii9003 * Modify help statement to clarify consistency * Minor tweak * Control BLFWriter max container size * Fix formatting * Update can/logger.py Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com> * Revert "Fix formatting" This reverts commit 3afb140a09c4c0a5394f5a89d7e0d49397c4a37d. * Revert "Control BLFWriter max container size" This reverts commit c39719ccf88ef9c6eae8facffcac063a10f519c5. Co-authored-by: j-c-cook Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com> --- can/logger.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/can/logger.py b/can/logger.py index 0b73dd785..8cb201987 100644 --- a/can/logger.py +++ b/can/logger.py @@ -193,9 +193,10 @@ def main() -> None: "--file_size", dest="file_size", type=int, - help="Maximum file size in bytes (or for the case of blf, maximum " - "buffer size before compression and flush to file). Rotate log " - "file when size threshold is reached.", + help="Maximum file size in bytes. Rotate log file when size threshold " + "is reached. (The resulting file sizes will be consistent, but are not " + "guaranteed to be exactly what is specified here due to the rollover " + "conditions being logger implementation specific.)", default=None, )