| Message ID | a24cbbe955f45072ffa88ca16f84e2443720a38f.1614062288.git.liu.denton@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs: misc cleanup | expand |
On Tue, Feb 23, 2021 at 1:41 AM Denton Liu <liu.denton@gmail.com> wrote: > As part of the hash-transition, git can operate on more than just SHA-1 > repositories. Replace "sha1"-specific documentation with hash-agnostic > terminology. > > Signed-off-by: Denton Liu <liu.denton@gmail.com> > --- > diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt > @@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a > `objectname`:: > - The 40-hex object name of the object. > + The full hex representation of the object. I find this new terminology confusing and ambiguous. To me, this seems to be saying that it is a hex representation of the entire object rather than a hex representation of the hash of the object. Perhaps say either "hex representation of the hash of the object" or "hex representation of the object ID"? > @@ -215,8 +215,8 @@ newline. The available atoms are: > `deltabase`:: > If the object is stored as a delta on-disk, this expands to the > - 40-hex sha1 of the delta base object. Otherwise, expands to the > - null sha1 (40 zeroes). See `CAVEATS` below. > + full hex representation of the delta base object. Otherwise, expands to the > + null OID (all zeroes). See `CAVEATS` below. Same issue. "hex representation of the delta base object" sounds misleading. Should probably mention "hash of the" in there somewhere or something.
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index 987d170506..ff89c7bfab 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a newline. The available atoms are: `objectname`:: - The 40-hex object name of the object. + The full hex representation of the object. `objecttype`:: The type of the object (the same as `cat-file -t` reports). @@ -215,8 +215,8 @@ newline. The available atoms are: `deltabase`:: If the object is stored as a delta on-disk, this expands to the - 40-hex sha1 of the delta base object. Otherwise, expands to the - null sha1 (40 zeroes). See `CAVEATS` below. + full hex representation of the delta base object. Otherwise, expands to the + null OID (all zeroes). See `CAVEATS` below. `rest`:: If this atom is used in the output string, input lines are split @@ -235,14 +235,14 @@ newline. For example, `--batch` without a custom format would produce: ------------ -<sha1> SP <type> SP <size> LF +<oid> SP <type> SP <size> LF <contents> LF ------------ Whereas `--batch-check='%(objectname) %(objecttype)'` would produce: ------------ -<sha1> SP <type> LF +<oid> SP <type> LF ------------ If a name is specified on stdin that cannot be resolved to an object in
As part of the hash-transition, git can operate on more than just SHA-1 repositories. Replace "sha1"-specific documentation with hash-agnostic terminology. Signed-off-by: Denton Liu <liu.denton@gmail.com> --- Documentation/git-cat-file.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)