[thirdparty/git.git] / Documentation / git-hash-object.txt

git-hash-object(1)
==================

NAME
----
git-hash-object - Compute object ID and optionally creates a blob 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.
This is used by 'git cvsimport' to update the index
without modifying files in the work tree.  When <type> is not
specified, it defaults to "blob".

OPTIONS
-------

-t <type>::
	Specify the type (default: "blob").

-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
Commit	Line	Data
7672db20 BL	1	git-hash-object(1)
7672db20 BL	2	==================
7672db20 BL	3
	4	NAME
	5	----
c3f0baac	6	git-hash-object - Compute object ID and optionally creates a blob from a file
7672db20 BL	7
	8
	9	SYNOPSIS
	10	--------
9ae8e008	11	[verse]
83115ac4	12	'git hash-object' [-t <type>] [-w] [--path=<file>\|--no-filters] [--stdin [--literally]] [--] <file>...
33e8fc87	13	'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
7672db20 BL	14
	15	DESCRIPTION
	16	-----------
	17	Computes the object ID value for an object with specified type
	18	with the contents of the named file (which can be outside of the
	19	work tree), and optionally writes the resulting object into the
	20	object database. Reports its object ID to its standard output.
0b444cdb	21	This is used by 'git cvsimport' to update the index
7672db20	22	without modifying files in the work tree. When <type> is not
a6080a0a	23	specified, it defaults to "blob".
7672db20	24
2c6e4771 JS	25	OPTIONS
	26	-------
	27
	28	-t <type>::
	29	Specify the type (default: "blob").
	30
	31	-w::
	32	Actually write the object into the object database.
7672db20	33
024510c8 DB	34	--stdin::
	35	Read the object from standard input instead of from a file.
	36
d8ee4832	37	--stdin-paths::
33e8fc87 JH	38	Read file names from the standard input, one per line, instead
33e8fc87 JH	39	of from the command-line.
d8ee4832	40
39702431 DP	41	--path::
	42	Hash object as it were located at the given path. The location of
	43	file does not directly influence on the hash value, but path is
2de9b711	44	used to determine what Git filters should be applied to the object
39702431 DP	45	before it can be placed to the object database, and, as result of
	46	applying filters, the actual blob put into the object database may
	47	differ from the given file. This option is mainly useful for hashing
	48	temporary files located outside of the working directory or files
	49	read from stdin.
	50
4a3d85dc DP	51	--no-filters::
4a3d85dc DP	52	Hash the contents as is, ignoring any input filter that would
6b677a28	53	have been chosen by the attributes mechanism, including the end-of-line
4a3d85dc	54	conversion. If the file is read from standard input then this
83115ac4 ES	55	is always implied, unless the `--path` option is given.
	56
	57	--literally::
	58	Allow `--stdin` to hash any garbage into a loose object which might not
	59	otherwise pass standard object parsing or git-fsck checks. Useful for
	60	stress-testing Git itself or reproducing characteristics of corrupt or
	61	bogus objects encountered in the wild.
4a3d85dc	62
7672db20 BL	63	GIT
7672db20 BL	64	---
9e1f0a85	65	Part of the linkgit:git[1] suite