Documentation/git-archimport.txt

   1 git-archimport(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-archimport - Import a GNU 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>[:<git-branch>] ...
  14
  15 DESCRIPTION
  16 -----------
  17 Imports a project from one or more GNU Arch repositories.
  18 It will follow branches
  19 and repositories within the namespaces defined by the <archive/branch>
  20 parameters supplied. If it cannot find the remote branch a merge comes from
  21 it will just import it as a regular commit. If it can find it, it will mark it
  22 as a merge whenever possible (see discussion below).
  23
  24 The script expects you to provide the key roots where it can start the import
  25 from an 'initial import' or 'tag' type of Arch commit. It will follow and
  26 import new branches within the provided roots.
  27
  28 It expects to be dealing with one project only. If it sees
  29 branches that have different roots, it will refuse to run. In that case,
  30 edit your <archive/branch> parameters to define clearly the scope of the
  31 import.
  32
  33 'git archimport' uses `tla` extensively in the background to access the
  34 Arch repository.
  35 Make sure you have a recent version of `tla` available in the path. `tla` must
  36 know about the repositories you pass to 'git archimport'.
  37
  38 For the initial import, 'git archimport' expects to find itself in an empty
  39 directory. To follow the development of a project that uses Arch, rerun
  40 'git archimport' with the same parameters as the initial import to perform
  41 incremental imports.
  42
  43 While 'git archimport' will try to create sensible branch names for the
  44 archives that it imports, it is also possible to specify Git branch names
  45 manually.  To do so, write a Git branch name after each <archive/branch>
  46 parameter, separated by a colon.  This way, you can shorten the Arch
  47 branch names and convert Arch jargon to Git jargon, for example mapping a
  48 "PROJECT{litdd}devo{litdd}VERSION" branch to "master".
  49
  50 Associating multiple Arch branches to one Git branch is possible; the
  51 result will make the most sense only if no commits are made to the first
  52 branch, after the second branch is created.  Still, this is useful to
  53 convert Arch repositories that had been rotated periodically.
  54
  55
  56 MERGES
  57 ------
  58 Patch merge data from Arch is used to mark merges in Git as well. Git
  59 does not care much about tracking patches, and only considers a merge when a
  60 branch incorporates all the commits since the point they forked. The end result
  61 is that Git will have a good idea of how far branches have diverged. So the
  62 import process does lose some patch-trading metadata.
  63
  64 Fortunately, when you try and merge branches imported from Arch,
  65 Git will find a good merge base, and it has a good chance of identifying
  66 patches that have been traded out-of-sequence between the branches.
  67
  68 OPTIONS
  69 -------
  70
  71 -h::
  72         Display usage.
  73
  74 -v::
  75         Verbose output.
  76
  77 -T::
  78         Many tags. Will create a tag for every commit, reflecting the commit
  79         name in the Arch repository.
  80
  81 -f::
  82         Use the fast patchset import strategy.  This can be significantly
  83         faster for large trees, but cannot handle directory renames or
  84         permissions changes.  The default strategy is slow and safe.
  85
  86 -o::
  87         Use this for compatibility with old-style branch names used by
  88         earlier versions of 'git archimport'.  Old-style branch names
  89         were category{litdd}branch, whereas new-style branch names are
  90         archive,category{litdd}branch{litdd}version.  In both cases, names given
  91         on the command-line will override the automatically-generated
  92         ones.
  93
  94 -D <depth>::
  95         Follow merge ancestry and attempt to import trees that have been
  96         merged from.  Specify a depth greater than 1 if patch logs have been
  97         pruned.
  98
  99 -a::
 100         Attempt to auto-register archives at `http://mirrors.sourcecontrol.net`
 101         This is particularly useful with the -D option.
 102
 103 -t <tmpdir>::
 104         Override the default tempdir.
 105
 106
 107 <archive/branch>::
 108         Archive/branch identifier in a format that `tla log` understands.
 109
 110
 111 GIT
 112 ---
 113 Part of the linkgit:git[1] suite