]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: fix hex code escapes in git-ls-files
authorJayson Rhynas <jayrhynas@gmail.com>
Fri, 26 Jul 2024 15:41:40 +0000 (11:41 -0400)
committerJunio C Hamano <gitster@pobox.com>
Fri, 26 Jul 2024 17:53:21 +0000 (10:53 -0700)
The --format option on the git-ls-files man page states that `%xx`
interpolates to the character with hex code `xx`. This mirrors the
documentation and behavior of `git for-each-ref --format=...`. However,
in reality it requires the character with code `XX` to be specified as
`%xXX`, mirroring the behaviour of  `git log --format`.

Signed-off-by: Jayson Rhynas <jayrhynas@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-ls-files.txt

index d08c7da8f495b3e19fb763535ff742585da9ce3e..58c529afbee4c5534cf34f3250161f2eeddf254f 100644 (file)
@@ -219,9 +219,9 @@ followed by the  ("attr/<eolattr>").
 
 --format=<format>::
        A string that interpolates `%(fieldname)` from the result being shown.
-       It also interpolates `%%` to `%`, and `%xx` where `xx` are hex digits
-       interpolates to character with hex code `xx`; for example `%00`
-       interpolates to `\0` (NUL), `%09` to `\t` (TAB) and %0a to `\n` (LF).
+       It also interpolates `%%` to `%`, and `%xXX` where `XX` are hex digits
+       interpolates to character with hex code `XX`; for example `%x00`
+       interpolates to `\0` (NUL), `%x09` to `\t` (TAB) and %x0a to `\n` (LF).
        --format cannot be combined with `-s`, `-o`, `-k`, `-t`, `--resolve-undo`
        and `--eol`.
 \--::