Merge git://git.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-archimport.txt
1 git-archimport(1)
2 =================
3
4 NAME
5 ----
6 git-archimport - Import an Arch repository into git
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 `git-archimport` [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
13 <archive/branch> [ <archive/branch> ]
14
15 DESCRIPTION
16 -----------
17 Imports a project from one or more Arch repositories. It will follow branches
18 and repositories within the namespaces defined by the <archive/branch>
19 parameters supplied. If it cannot find the remote branch a merge comes from
20 it will just import it as a regular commit. If it can find it, it will mark it
21 as a merge whenever possible (see discussion below).
22
23 The script expects you to provide the key roots where it can start the import
24 from an 'initial import' or 'tag' type of Arch commit. It will follow and
25 import new branches within the provided roots.
26
27 It expects to be dealing with one project only. If it sees
28 branches that have different roots, it will refuse to run. In that case,
29 edit your <archive/branch> parameters to define clearly the scope of the
30 import.
31
32 `git-archimport` uses `tla` extensively in the background to access the
33 Arch repository.
34 Make sure you have a recent version of `tla` available in the path. `tla` must
35 know about the repositories you pass to `git-archimport`.
36
37 For the initial import `git-archimport` expects to find itself in an empty
38 directory. To follow the development of a project that uses Arch, rerun
39 `git-archimport` with the same parameters as the initial import to perform
40 incremental imports.
41
42 MERGES
43 ------
44 Patch merge data from Arch is used to mark merges in git as well. git
45 does not care much about tracking patches, and only considers a merge when a
46 branch incorporates all the commits since the point they forked. The end result
47 is that git will have a good idea of how far branches have diverged. So the
48 import process does lose some patch-trading metadata.
49
50 Fortunately, when you try and merge branches imported from Arch,
51 git will find a good merge base, and it has a good chance of identifying
52 patches that have been traded out-of-sequence between the branches.
53
54 OPTIONS
55 -------
56
57 -h::
58 Display usage.
59
60 -v::
61 Verbose output.
62
63 -T::
64 Many tags. Will create a tag for every commit, reflecting the commit
65 name in the Arch repository.
66
67 -f::
68 Use the fast patchset import strategy. This can be significantly
69 faster for large trees, but cannot handle directory renames or
70 permissions changes. The default strategy is slow and safe.
71
72 -o::
73 Use this for compatibility with old-style branch names used by
74 earlier versions of git-archimport. Old-style branch names
75 were category--branch, whereas new-style branch names are
76 archive,category--branch--version.
77
78 -D <depth>::
79 Follow merge ancestry and attempt to import trees that have been
80 merged from. Specify a depth greater than 1 if patch logs have been
81 pruned.
82
83 -a::
84 Attempt to auto-register archives at http://mirrors.sourcecontrol.net
85 This is particularly useful with the -D option.
86
87 -t <tmpdir>::
88 Override the default tempdir.
89
90
91 <archive/branch>::
92 Archive/branch identifier in a format that `tla log` understands.
93
94
95 Author
96 ------
97 Written by Martin Langhoff <martin@catalyst.net.nz>.
98
99 Documentation
100 --------------
101 Documentation by Junio C Hamano, Martin Langhoff and the git-list <git@vger.kernel.org>.
102
103 GIT
104 ---
105 Part of the gitlink:git[7] suite
106