Modify file_size help doc string (hardbyte#1401)

* Modify `file_size` help doc string

* Add note to BLFWriter

* Revert "Add note to BLFWriter"

This reverts commit 18241ac.

* 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 <[email protected]>

* Revert "Fix formatting"

This reverts commit 3afb140.

* Revert "Control BLFWriter max container size"

This reverts commit c39719c.

Co-authored-by: j-c-cook <[email protected]>
Co-authored-by: zariiii9003 <[email protected]>

Author: 3 people

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,
     )