annotate docs/notes.rst @ 212:7cf9df49d0ba

Some notes about FLAGS
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 23 Jan 2025 14:04:07 +0100
parents efbf99bd0910
children 19eaba51c632
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
212
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
194
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 In a aggregated directory checksum at the end of a block:
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5 A path equals
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 ``./@/``
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Symlink to directory
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 ``./@``
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 Symlink to other filesystem object
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 Other paths that *end* with:
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 ``/./@/``
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 Symlink to a directory
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 ``/./@`
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22
938488f87b62 Begin a file with some notes on treesum.py and its digest file format
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 Symlink to other filesystem object
198
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
24
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
25
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
26 Fields:
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
27
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
28 ``FSENCODING``
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
29
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
30 The result of :func:`os.getfilesystemencoding` that is in effect when
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding>
Franz Glasner <fzglas.hg@dom66.de>
parents: 194
diff changeset
31 generating treesum digests
204
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
32
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
33 ``ERROR``
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
34
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
35 Errors are reported:
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
36
07f1d79e6674 Fully implemented UTF-8 mode for treeview.
Franz Glasner <fzglas.hg@dom66.de>
parents: 198
diff changeset
37 - For directories if the one of filenames has a filename problem
209
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
38
212
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
39 ``FLAGS``
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
40
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
41 Defaults without any flags:
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
42
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
43 - not following any symlinks (but :option:`--no-follow-file-symlinks` is
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
44 not yet supported and coerced to :option:`--follow-file-symlinks`)
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
45 - no modes- no mtime
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
46 - filenames are in filesystem encoding
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
47 - no file size is printed
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
48
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
49 Contains:
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
50
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
51 - ``with-metadata-fullmode``: if a file mode is used completely as
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
52 given by the OS for digest computation
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
53 - ``with-metadata-mode``: if just the "portable" file modes are used
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
54 for digest computation
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
55 - ``with-metadata-mtime``: if the mtime as ISO-String and truncated to
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
56 seconds is used in digest computation
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
57 - ``print-size``: if the filesize is to to be printed also
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
58 - ``utf8-mode``: the filenames are not in FS encoding but in UTF-8
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
59 - ``follow-symlinks-XXX`: if symlinks are followed on the command
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
60 line, while directory walking or for files
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
61 - ``size-only``: if no digest is to be computed and only a file's size
7cf9df49d0ba Some notes about FLAGS
Franz Glasner <fzglas.hg@dom66.de>
parents: 209
diff changeset
62 is printed and the accumulated file sizes for a directory tree
209
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
63
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
64
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
65 Offene Fragen
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
66 =============
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
67
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
68 VFAT und Encoding
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
69 -----------------
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
70
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
71 Verfolgung von Encoding-Einstellungen über Mount-Punkte hinweg -- gerade
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
72 für externe Medien mit VFAT/MSDOS-FS.
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
73
efbf99bd0910 VFAT-Encoding-Problem notiert
Franz Glasner <fzglas.hg@dom66.de>
parents: 204
diff changeset
74 Erst einmal zurückgestellt