Merge branch 't/misc/quot-hex' into refs/top-bases/master
[git/repo.git] / Documentation / git-fast-export.txt
blobb974e2115b01f17f0ac809b691baf2f4e4d32169
1 git-fast-export(1)
2 ==================
4 NAME
5 ----
6 git-fast-export - Git data exporter
9 SYNOPSIS
10 --------
11 'git fast-export [options]' | 'git fast-import'
13 DESCRIPTION
14 -----------
15 This program dumps the given revisions in a form suitable to be piped
16 into 'git-fast-import'.
18 You can use it as a human readable bundle replacement (see
19 linkgit:git-bundle[1]), or as a kind of an interactive
20 'git-filter-branch'.
23 OPTIONS
24 -------
25 --progress=<n>::
26         Insert 'progress' statements every <n> objects, to be shown by
27         'git-fast-import' during import.
29 --signed-tags=(verbatim|warn|strip|abort)::
30         Specify how to handle signed tags.  Since any transformation
31         after the export can change the tag names (which can also happen
32         when excluding revisions) the signatures will not match.
34 When asking to 'abort' (which is the default), this program will die
35 when encountering a signed tag.  With 'strip', the tags will be made
36 unsigned, with 'verbatim', they will be silently exported
37 and with 'warn', they will be exported, but you will see a warning.
39 -M::
40 -C::
41         Perform move and/or copy detection, as described in the
42         linkgit:git-diff[1] manual page, and use it to generate
43         rename and copy commands in the output dump.
45 Note that earlier versions of this command did not complain and
46 produced incorrect results if you gave these options.
48 --export-marks=<file>::
49         Dumps the internal marks table to <file> when complete.
50         Marks are written one per line as `:markid SHA-1`. Only marks
51         for revisions are dumped; marks for blobs are ignored.
52         Backends can use this file to validate imports after they
53         have been completed, or to save the marks table across
54         incremental runs.  As <file> is only opened and truncated
55         at completion, the same path can also be safely given to
56         \--import-marks.
58 --import-marks=<file>::
59         Before processing any input, load the marks specified in
60         <file>.  The input file must exist, must be readable, and
61         must use the same format as produced by \--export-marks.
63 Any commits that have already been marked will not be exported again.
64 If the backend uses a similar \--import-marks file, this allows for
65 incremental bidirectional exporting of the repository by keeping the
66 marks the same across runs.
69 EXAMPLES
70 --------
72 -------------------------------------------------------------------
73 $ git fast-export --all | (cd /empty/repository && git fast-import)
74 -------------------------------------------------------------------
76 This will export the whole repository and import it into the existing
77 empty repository.  Except for reencoding commits that are not in
78 UTF-8, it would be a one-to-one mirror.
80 -----------------------------------------------------
81 $ git fast-export master~5..master |
82         sed "s|refs/heads/master|refs/heads/other|" |
83         git fast-import
84 -----------------------------------------------------
86 This makes a new branch called 'other' from 'master~5..master'
87 (i.e. if 'master' has linear history, it will take the last 5 commits).
89 Note that this assumes that none of the blobs and commit messages
90 referenced by that revision range contains the string
91 'refs/heads/master'.
94 Limitations
95 -----------
97 Since 'git-fast-import' cannot tag trees, you will not be
98 able to export the linux-2.6.git repository completely, as it contains
99 a tag referencing a tree instead of a commit.
102 Author
103 ------
104 Written by Johannes E. Schindelin <johannes.schindelin@gmx.de>.
106 Documentation
107 --------------
108 Documentation by Johannes E. Schindelin <johannes.schindelin@gmx.de>.
112 Part of the linkgit:git[1] suite