From: John Cai <johncai86@xxxxxxxxx>
For newer users of Git, the possible values of -t in git-hash-object may
not be apparent. In fact the current verbiage under NAME could
lead one to conclude that git-hash-object(1) can only be used to create
blobs.
Update the verbiage to make it clear the command can be used to write
objects, not just blobs. Also add the possible values for -t.
Signed-off-by: John Cai <johncai86@xxxxxxxxx>
---
docs: add git-hash-object -t option's possible values
For newer users of Git, the possible values of -t in git-hash-object may
not be apparent. In fact the current verbiage under NAME could lead one
to conclude that git-hash-object(1) can only be used to create blobs.
Update the verbiage to make it clear the command can be used to write
objects, not just blobs. Also add the possible values for -t.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1533%2Fjohn-cai%2Fjc%2Fhash-object-documentation-update-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1533/john-cai/jc/hash-object-documentation-update-v1
Pull-Request: https://github.com/git/git/pull/1533
Documentation/git-hash-object.txt | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt
index 472b5bb995b..404e339e170 100644
--- a/Documentation/git-hash-object.txt
+++ b/Documentation/git-hash-object.txt
@@ -3,7 +3,7 @@ git-hash-object(1)
NAME
----
-git-hash-object - Compute object ID and optionally creates a blob from a file
+git-hash-object - Compute object ID and optionally creates an object from a file
SYNOPSIS
@@ -25,7 +25,8 @@ OPTIONS
-------
-t <type>::
- Specify the type (default: "blob").
+ Specify the type (default: "blob"). Possible values are `commit`,
+ `tree`, `blob`, and `tag`.
-w::
Actually write the object into the object database.
base-commit: 6640c2d06d112675426cf436f0594f0e8c614848
--
gitgitgadget
