diff docs/notes.rst @ 219:19eaba51c632

Refactored the printing of FLAGS: print flags always and explicitely print symlink behaviour and encoding configuration
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 25 Jan 2025 13:49:12 +0100
parents 7cf9df49d0ba
children d7be68a8937d
line wrap: on
line diff
--- a/docs/notes.rst	Sat Jan 25 09:56:19 2025 +0100
+++ b/docs/notes.rst	Sat Jan 25 13:49:12 2025 +0100
@@ -28,7 +28,7 @@
   ``FSENCODING``
 
       The result of :func:`os.getfilesystemencoding` that is in effect when
-      generating treesum digests
+      generating treesum digests (process environment)
 
    ``ERROR``
 
@@ -38,12 +38,9 @@
 
    ``FLAGS``
 
-      Defaults without any flags:
+      Some flags are always printed.
 
-      - not following any symlinks (but :option:`--no-follow-file-symlinks` is
-        not yet supported and coerced to :option:`--follow-file-symlinks`)
-      - no modes- no mtime
-      - filenames are in filesystem encoding
+      - no file modes and no file mtime is taken into account for digesting
       - no file size is printed
 
       Contains:
@@ -54,9 +51,11 @@
         for digest computation
       - ``with-metadata-mtime``: if the mtime as ISO-String and truncated to
         seconds is used in digest computation
-      - ``print-size``: if the filesize is to to be printed also
-      - ``utf8-mode``: the filenames are not in FS encoding but in UTF-8
-      - ``follow-symlinks-XXX`: if symlinks are followed on the command
+      - ``print-size``: if the filesize is to to be printed also -- does not
+                        change digests
+      - ``fs-encoding``: the filenames are given in FS encoding
+      - ``utf8-encoding``: the filenames are given in UTF-8 encoding
+      - ``follow-symlinks-XXX`` and ``no-follow-symlinkx-XXX``: if symlinks are followed on the command
         line, while directory walking or for files
       - ``size-only``: if no digest is to be computed and only a file's size
         is printed and the accumulated file sizes for a directory tree