aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2025-04-13 09:52:43 -0700
committerJack O'Connor <[email protected]>2025-04-13 10:04:02 -0700
commitd30b38db0001457963a7fbe1e759e443c911bd9d (patch)
treea2b312d901e8a6cb5cedc1cd3b129602a416a2f8
parentbafe693a8238803e6abcdba9dce291d209eb82c7 (diff)
update what_does_check_do.md to mention \r escaping
Windows newline escaping was added in b3sum v1.5.5 last year (1170f023bf459ea3d0bedd285d6ae32309ee348c), and this commit updates the check doc to reflect that. Note that Coreutils added \r escaping in v9.0 in 2021 (https://github.com/coreutils/coreutils/commit/ed1c58427d574fb4ff0cb8f915eb0d554000ceeb), a year after the original check doc was written.
-rw-r--r--b3sum/what_does_check_do.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/b3sum/what_does_check_do.md b/b3sum/what_does_check_do.md
index 3af0e53..387c490 100644
--- a/b3sum/what_does_check_do.md
+++ b/b3sum/what_does_check_do.md
@@ -74,9 +74,11 @@ Notice two things. First, `b3sum` puts a single `\` character at the front of
the line. This indicates that the filepath contains escape sequences that
`b3sum --check` will need to unescape. Then, `b3sum` replaces the newline
character in the filepath with the two-character escape sequence `\n`.
-Similarly, if the filepath contained a backslash, `b3sum` would escape it as
-`\\` in the output. So far, all of this behavior is still identical to
-`md5sum`.
+Similarly, if the filepath contained carriage returns or backslashes, `b3sum`
+would escape those as `\r` and `\\` in the output. So far, all of this behavior
+is still identical to `md5sum`. (Note: Coreutils [introduced `\r`
+escaping](https://github.com/coreutils/coreutils/commit/ed1c58427d574fb4ff0cb8f915eb0d554000ceeb)
+in v9.0, September 2021.)
## Invalid Unicode