[PATCH] archimport documentation update
Updated and expanded the command description, and added a reference of the command line options. Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>
martin@catalyst.net.nz committed
Sep 11, 2005 at 21:26 UTC
a4c5f9aab740b6d3972c395d4b1af10c2026244b
1 file changed
+49
-10
Documentation/git-archimport.txt
+49
-10
@@ -8,24 +8,63 @@ git-archimport - Import an arch repository into git
8
9
SYNOPSIS
10
--------
11
-`git-archimport` [--option...] <args>
11
+`git-archimport` [ -h ] [ -v ] [ -T ] [ -t tempdir ]
12
+ <archive/branch> [ <archive/branch> ]
13
14
DESCRIPTION
15
-----------
15
-The script expects you to provide the key roots where it can start the
16
-import from an 'initial import' or 'tag' type of Arch commit. It will
17
-then follow all the branching and tagging within the provided roots.
16
+Imports a project from one or more Arch repositories. It will follow branches
17
+and repositories within the namespaces defined by the <archive/branch>
18
+parameters suppplied. If it cannot find the remote branch a merge comes from
19
+it will just import it as a regular merge. If it can find it, it will perform
20
+a merge whenever possible.
21
19
-It will die if it sees branches that have different roots.
22
+The script expects you to provide the key roots where it can start the import
23
+from an 'initial import' or 'tag' type of Arch commit. It will follow and import
24
+new branches within the provided roots.
25
26
+It expects to be dealing with one project only. If it sees
27
+branches that have different roots, it will refuse to run. In that case, edit your
28
+<archive/branch> parameters to define clearly the scope of the import.
29
+
30
+`git-archimport` uses `tla` extensively in the background to access the Arch repository.
31
+Make sure you have a recent version of `tla` available in the path. `tla` must
32
+know about the repositories you pass to `git-archimport`.
33
+
34
+For the initial import `git-archimport` expects to find itself in an empty
35
+directory. To follow the development of a project that uses Arch, rerun
36
+`git-archimport` with the same parameters as the initial import to perform incremental imports.
37
+of a project using Arch.
38
+
39
+Patch merge data from Arch is used to mark merges in GIT as well. GIT
40
+does not care much about tracking patches, and only considers a merge when a
41
+branch incorporates all the commits since the point they forked. The end result
42
+is that GIT will have a good idea of how far branches have diverged. So the
43
+import process does lose some patch-trading metadata.
44
+
45
+Fortunately, when you try and merge branches imported from Arch,
46
+GIT will find a good merge base, and it has a good chance of identifying
47
+patches that have been traded out-of-sequence between the branches.
48
49
OPTIONS
50
-------
24
---option::
25
- Some option not yet documented.
51
27
-<args>...::
28
- Some argument not yet documented.
52
+-h::
53
+ Display usage.
54
+
55
+-v::
56
+ Verbose output.
57
+
58
+-T::
59
+ Many tags. Will create a tag for every commit, reflecting the commit
60
+ name in the Arch repository.
61
+
62
+-t <tmpdir>::
63
+ Override the default tempdir.
64
+
65
+
66
+<archive/branch>::
67
+ Archive/branch identifier in a format that `tla log` understands.
68
69
70
Author
@@ -34,7 +73,7 @@ Written by Martin Langhoff <martin@catalyst.net.nz>.
73
74
Documentation
75
--------------
37
-Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
76
+Documentation by Junio C Hamano, Martin Langhoff and the git-list <git@vger.kernel.org>.
77
78
GIT
79
---