Skip to content

Commit d4f2827

Browse files
john-caigitster
authored andcommitted
docs: add git hash-object -t option's possible values
The summary under the NAME section for git hash-object can mislead readers to conclude that the command can only be used to create blobs, whereas the description makes it clear that it can be used to create objects, not just blobs. Let's clarify the one-line summary. Further, the description for the option -t does not list out other types that can be used when creating objects. Let's make this explicit by listing out the different object types. Signed-off-by: John Cai <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent fe86abd commit d4f2827

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/git-hash-object.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-hash-object(1)
33

44
NAME
55
----
6-
git-hash-object - Compute object ID and optionally creates a blob from a file
6+
git-hash-object - Compute object ID and optionally create an object from a file
77

88

99
SYNOPSIS
@@ -25,7 +25,8 @@ OPTIONS
2525
-------
2626

2727
-t <type>::
28-
Specify the type (default: "blob").
28+
Specify the type of object to be created (default: "blob"). Possible
29+
values are `commit`, `tree`, `blob`, and `tag`.
2930

3031
-w::
3132
Actually write the object into the object database.

0 commit comments

Comments
 (0)