diff options
author | Jean-Noël Avila <jn.avila@free.fr> | 2023-12-25 21:21:26 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2023-12-26 11:06:55 -0800 |
commit | 2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch) | |
tree | 9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/user-manual.txt | |
parent | 055bb6e9969085777b7fab83e3fee0017654f134 (diff) | |
download | git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz |
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders
are to be separated by dashes, not underscores nor spaces.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r-- | Documentation/user-manual.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index d8dbe6b56d..163e8fe77a 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -4100,8 +4100,8 @@ independently of the contents or the type of the object: all objects can be validated by verifying that (a) their hashes match the content of the file and (b) the object successfully inflates to a stream of bytes that forms a sequence of -`<ascii type without space> + <space> + <ascii decimal size> + -<byte\0> + <binary object data>`. +`<ascii-type-without-space> + <space> + <ascii-decimal-size> + +<byte\0> + <binary-object-data>`. The structured objects can further have their structure and connectivity to other objects verified. This is generally done with |