Merge branch 'ab/doc-replace-gmane-links' into maint
[alt-git.git] / Documentation / git-hash-object.txt
blob814e74406ae4fb6ac68213df1f7e8e0192d1dbaf
1 git-hash-object(1)
2 ==================
4 NAME
5 ----
6 git-hash-object - Compute object ID and optionally creates a blob from a file
9 SYNOPSIS
10 --------
11 [verse]
12 'git hash-object' [-t <type>] [-w] [--path=<file>|--no-filters] [--stdin [--literally]] [--] <file>...
13 'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
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.
21 This is used by 'git cvsimport' to update the index
22 without modifying files in the work tree.  When <type> is not
23 specified, it defaults to "blob".
25 OPTIONS
26 -------
28 -t <type>::
29         Specify the type (default: "blob").
31 -w::
32         Actually write the object into the object database.
34 --stdin::
35         Read the object from standard input instead of from a file.
37 --stdin-paths::
38         Read file names from the standard input, one per line, instead
39         of from the command-line.
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
44         used to determine what Git filters should be applied to the object
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.
51 --no-filters::
52         Hash the contents as is, ignoring any input filter that would
53         have been chosen by the attributes mechanism, including the end-of-line
54         conversion. If the file is read from standard input then this
55         is always implied, unless the `--path` option is given.
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.
63 GIT
64 ---
65 Part of the linkgit:git[1] suite