Skip to content

Commit d30b38d

Browse files
committed
update what_does_check_do.md to mention \r escaping
Windows newline escaping was added in b3sum v1.5.5 last year (1170f02), and this commit updates the check doc to reflect that. Note that Coreutils added \r escaping in v9.0 in 2021 (coreutils/coreutils@ed1c584), a year after the original check doc was written.
1 parent bafe693 commit d30b38d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

b3sum/what_does_check_do.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,11 @@ Notice two things. First, `b3sum` puts a single `\` character at the front of
7474
the line. This indicates that the filepath contains escape sequences that
7575
`b3sum --check` will need to unescape. Then, `b3sum` replaces the newline
7676
character in the filepath with the two-character escape sequence `\n`.
77-
Similarly, if the filepath contained a backslash, `b3sum` would escape it as
78-
`\\` in the output. So far, all of this behavior is still identical to
79-
`md5sum`.
77+
Similarly, if the filepath contained carriage returns or backslashes, `b3sum`
78+
would escape those as `\r` and `\\` in the output. So far, all of this behavior
79+
is still identical to `md5sum`. (Note: Coreutils [introduced `\r`
80+
escaping](https://github.com/coreutils/coreutils/commit/ed1c58427d574fb4ff0cb8f915eb0d554000ceeb)
81+
in v9.0, September 2021.)
8082

8183
## Invalid Unicode
8284

0 commit comments

Comments
 (0)