mirror of
https://github.com/git/git
synced 2024-08-25 10:45:59 +00:00
d4f28279ad
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 <johncai86@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
66 lines
2.1 KiB
Plaintext
66 lines
2.1 KiB
Plaintext
git-hash-object(1)
|
|
==================
|
|
|
|
NAME
|
|
----
|
|
git-hash-object - Compute object ID and optionally create an object from a file
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git hash-object' [-t <type>] [-w] [--path=<file> | --no-filters]
|
|
[--stdin [--literally]] [--] <file>...
|
|
'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Computes the object ID value for an object with specified type
|
|
with the contents of the named file (which can be outside of the
|
|
work tree), and optionally writes the resulting object into the
|
|
object database. Reports its object ID to its standard output.
|
|
When <type> is not specified, it defaults to "blob".
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
-t <type>::
|
|
Specify the type of object to be created (default: "blob"). Possible
|
|
values are `commit`, `tree`, `blob`, and `tag`.
|
|
|
|
-w::
|
|
Actually write the object into the object database.
|
|
|
|
--stdin::
|
|
Read the object from standard input instead of from a file.
|
|
|
|
--stdin-paths::
|
|
Read file names from the standard input, one per line, instead
|
|
of from the command-line.
|
|
|
|
--path::
|
|
Hash object as it were located at the given path. The location of
|
|
file does not directly influence on the hash value, but path is
|
|
used to determine what Git filters should be applied to the object
|
|
before it can be placed to the object database, and, as result of
|
|
applying filters, the actual blob put into the object database may
|
|
differ from the given file. This option is mainly useful for hashing
|
|
temporary files located outside of the working directory or files
|
|
read from stdin.
|
|
|
|
--no-filters::
|
|
Hash the contents as is, ignoring any input filter that would
|
|
have been chosen by the attributes mechanism, including the end-of-line
|
|
conversion. If the file is read from standard input then this
|
|
is always implied, unless the `--path` option is given.
|
|
|
|
--literally::
|
|
Allow `--stdin` to hash any garbage into a loose object which might not
|
|
otherwise pass standard object parsing or git-fsck checks. Useful for
|
|
stress-testing Git itself or reproducing characteristics of corrupt or
|
|
bogus objects encountered in the wild.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|