git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] docs: add git hash-object -t option's possible values

From
John Cai via GitGitGadget <gitgitgadget@gmail.com>
Date
Jun 23, 2023, 21:25 UTC
Message-ID
<pull.1533.v2.git.git.1687555504551.gitgitgadget@gmail.com>
In-Reply-To
<pull.1533.git.git.1687394795009.gitgitgadget@gmail.com>
From: John Cai <johncai86@gmail.com>

The verbiage under the NAME section for git hash-object could lead one to conclude that git hash-object can only be used to create blobs when in fact the description makes it clear that it can be used to create objects, not just blobs. Lets clarify this in the NAME text.

Further, the description for the option -t does not list out other types that can be used. Let's make this explicit by listing out the different object types.

Signed-off-by: John Cai <johncai86@gmail.com>
---
    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.
    
    Changes since v1:
    
     * updated verbiage of commit message
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1533%2Fjohn-cai%2Fjc%2Fhash-object-documentation-update-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1533/john-cai/jc/hash-object-documentation-update-v2
Pull-Request: https://github.com/git/git/pull/1533
Range-diff vs v1:
 1:  38515c660fb ! 1:  2483375ecb8 docs: add git-hash-object -t option's possible values
     @@ Metadata
      Author: John Cai <johncai86@gmail.com>
      
       ## Commit message ##
     -    docs: add git-hash-object -t option's possible values
     +    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.
     +    The verbiage under the NAME section for git hash-object could
     +    lead one to conclude that git hash-object can only be used to create
     +    blobs when in fact the description makes it clear that it can be used to
     +    create objects, not just blobs. Lets clarify this in the NAME text.
      
     -    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.
     +    Further, the description for the option -t does not list out other types
     +    that can be used. Let's make this explicit by listing out the different
     +    object types.
      
          Signed-off-by: John Cai <johncai86@gmail.com>
      
 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
Previous: John CaiNext: Junio C Hamano
Message 7 of 10 in “docs: add git-hash-object -t option's possible values”
  1. docs: add git-hash-object -t option's possible valuesJohn Cai via GitGitGadget, Jun 22, 2023
  2. brian m. carlsonJun 22, 2023
  3. Junio C HamanoJun 22, 2023
  4. Taylor BlauJun 22, 2023
  5. Junio C HamanoJun 22, 2023
  6. John CaiJun 23, 2023
  7. docs: add git hash-object -t option's possible valuesJohn Cai via GitGitGadget, Jun 23, 2023
  8. Junio C HamanoJun 23, 2023
  9. docs: add git hash-object -t option's possible valuesJohn Cai via GitGitGadget, Jun 29, 2023
  10. Junio C HamanoJun 29, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.