teach fast-export an --anonymize option
[git] / Documentation / git-fast-export.txt
1 git-fast-export(1)
2 ==================
3
4 NAME
5 ----
6 git-fast-export - Git data exporter
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git fast-export [options]' | 'git fast-import'
13
14 DESCRIPTION
15 -----------
16 This program dumps the given revisions in a form suitable to be piped
17 into 'git fast-import'.
18
19 You can use it as a human-readable bundle replacement (see
20 linkgit:git-bundle[1]), or as a kind of an interactive
21 'git filter-branch'.
22
23
24 OPTIONS
25 -------
26 --progress=<n>::
27         Insert 'progress' statements every <n> objects, to be shown by
28         'git fast-import' during import.
29
30 --signed-tags=(verbatim|warn|warn-strip|strip|abort)::
31         Specify how to handle signed tags.  Since any transformation
32         after the export can change the tag names (which can also happen
33         when excluding revisions) the signatures will not match.
34 +
35 When asking to 'abort' (which is the default), this program will die
36 when encountering a signed tag.  With 'strip', the tags will silently
37 be made unsigned, with 'warn-strip' they will be made unsigned but a
38 warning will be displayed, with 'verbatim', they will be silently
39 exported and with 'warn', they will be exported, but you will see a
40 warning.
41
42 --tag-of-filtered-object=(abort|drop|rewrite)::
43         Specify how to handle tags whose tagged object is filtered out.
44         Since revisions and files to export can be limited by path,
45         tagged objects may be filtered completely.
46 +
47 When asking to 'abort' (which is the default), this program will die
48 when encountering such a tag.  With 'drop' it will omit such tags from
49 the output.  With 'rewrite', if the tagged object is a commit, it will
50 rewrite the tag to tag an ancestor commit (via parent rewriting; see
51 linkgit:git-rev-list[1])
52
53 -M::
54 -C::
55         Perform move and/or copy detection, as described in the
56         linkgit:git-diff[1] manual page, and use it to generate
57         rename and copy commands in the output dump.
58 +
59 Note that earlier versions of this command did not complain and
60 produced incorrect results if you gave these options.
61
62 --export-marks=<file>::
63         Dumps the internal marks table to <file> when complete.
64         Marks are written one per line as `:markid SHA-1`. Only marks
65         for revisions are dumped; marks for blobs are ignored.
66         Backends can use this file to validate imports after they
67         have been completed, or to save the marks table across
68         incremental runs.  As <file> is only opened and truncated
69         at completion, the same path can also be safely given to
70         \--import-marks.
71         The file will not be written if no new object has been
72         marked/exported.
73
74 --import-marks=<file>::
75         Before processing any input, load the marks specified in
76         <file>.  The input file must exist, must be readable, and
77         must use the same format as produced by \--export-marks.
78 +
79 Any commits that have already been marked will not be exported again.
80 If the backend uses a similar \--import-marks file, this allows for
81 incremental bidirectional exporting of the repository by keeping the
82 marks the same across runs.
83
84 --fake-missing-tagger::
85         Some old repositories have tags without a tagger.  The
86         fast-import protocol was pretty strict about that, and did not
87         allow that.  So fake a tagger to be able to fast-import the
88         output.
89
90 --use-done-feature::
91         Start the stream with a 'feature done' stanza, and terminate
92         it with a 'done' command.
93
94 --no-data::
95         Skip output of blob objects and instead refer to blobs via
96         their original SHA-1 hash.  This is useful when rewriting the
97         directory structure or history of a repository without
98         touching the contents of individual files.  Note that the
99         resulting stream can only be used by a repository which
100         already contains the necessary objects.
101
102 --full-tree::
103         This option will cause fast-export to issue a "deleteall"
104         directive for each commit followed by a full list of all files
105         in the commit (as opposed to just listing the files which are
106         different from the commit's first parent).
107
108 --anonymize::
109         Replace all refnames, paths, blob contents, commit and tag
110         messages, names, and email addresses in the output with
111         anonymized data, while still retaining the shape of history and
112         of the stored tree.
113
114 --refspec::
115         Apply the specified refspec to each ref exported. Multiple of them can
116         be specified.
117
118 [<git-rev-list-args>...]::
119         A list of arguments, acceptable to 'git rev-parse' and
120         'git rev-list', that specifies the specific objects and references
121         to export.  For example, `master~10..master` causes the
122         current master reference to be exported along with all objects
123         added since its 10th ancestor commit.
124
125 EXAMPLES
126 --------
127
128 -------------------------------------------------------------------
129 $ git fast-export --all | (cd /empty/repository && git fast-import)
130 -------------------------------------------------------------------
131
132 This will export the whole repository and import it into the existing
133 empty repository.  Except for reencoding commits that are not in
134 UTF-8, it would be a one-to-one mirror.
135
136 -----------------------------------------------------
137 $ git fast-export master~5..master |
138         sed "s|refs/heads/master|refs/heads/other|" |
139         git fast-import
140 -----------------------------------------------------
141
142 This makes a new branch called 'other' from 'master~5..master'
143 (i.e. if 'master' has linear history, it will take the last 5 commits).
144
145 Note that this assumes that none of the blobs and commit messages
146 referenced by that revision range contains the string
147 'refs/heads/master'.
148
149
150 Limitations
151 -----------
152
153 Since 'git fast-import' cannot tag trees, you will not be
154 able to export the linux.git repository completely, as it contains
155 a tag referencing a tree instead of a commit.
156
157 GIT
158 ---
159 Part of the linkgit:git[1] suite