doc/source/en/TortoiseGit/git_doc/git-archimport.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-archimport(1)">\r
   5 <articleinfo>\r
   6     <title>git-archimport(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-archimport(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-archimport - Import an Arch repository into git</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git archimport</emphasis> [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]\r
  19                &lt;archive/branch&gt;[:&lt;git-branch&gt;] &#8230;</literallayout>\r
  20 </blockquote>\r
  21 </simplesect>\r
  22 <simplesect id="_description">\r
  23 <title>DESCRIPTION</title>\r
  24 <simpara>Imports a project from one or more Arch repositories. It will follow branches\r
  25 and repositories within the namespaces defined by the &lt;archive/branch&gt;\r
  26 parameters supplied. If it cannot find the remote branch a merge comes from\r
  27 it will just import it as a regular commit. If it can find it, it will mark it\r
  28 as a merge whenever possible (see discussion below).</simpara>\r
  29 <simpara>The script expects you to provide the key roots where it can start the import\r
  30 from an <emphasis>initial import</emphasis> or <emphasis>tag</emphasis> type of Arch commit. It will follow and\r
  31 import new branches within the provided roots.</simpara>\r
  32 <simpara>It expects to be dealing with one project only. If it sees\r
  33 branches that have different roots, it will refuse to run. In that case,\r
  34 edit your &lt;archive/branch&gt; parameters to define clearly the scope of the\r
  35 import.</simpara>\r
  36 <simpara><emphasis>git archimport</emphasis> uses <emphasis>tla</emphasis> extensively in the background to access the\r
  37 Arch repository.\r
  38 Make sure you have a recent version of <emphasis>tla</emphasis> available in the path. <emphasis>tla</emphasis> must\r
  39 know about the repositories you pass to <emphasis>git archimport</emphasis>.</simpara>\r
  40 <simpara>For the initial import, <emphasis>git archimport</emphasis> expects to find itself in an empty\r
  41 directory. To follow the development of a project that uses Arch, rerun\r
  42 <emphasis>git archimport</emphasis> with the same parameters as the initial import to perform\r
  43 incremental imports.</simpara>\r
  44 <simpara>While <emphasis>git archimport</emphasis> will try to create sensible branch names for the\r
  45 archives that it imports, it is also possible to specify git branch names\r
  46 manually.  To do so, write a git branch name after each &lt;archive/branch&gt;\r
  47 parameter, separated by a colon.  This way, you can shorten the Arch\r
  48 branch names and convert Arch jargon to git jargon, for example mapping a\r
  49 "PROJECT&#45;&#45;devo&#45;&#45;VERSION" branch to "master".</simpara>\r
  50 <simpara>Associating multiple Arch branches to one git branch is possible; the\r
  51 result will make the most sense only if no commits are made to the first\r
  52 branch, after the second branch is created.  Still, this is useful to\r
  53 convert Arch repositories that had been rotated periodically.</simpara>\r
  54 </simplesect>\r
  55 <simplesect id="_merges">\r
  56 <title>MERGES</title>\r
  57 <simpara>Patch merge data from Arch is used to mark merges in git as well. git\r
  58 does not care much about tracking patches, and only considers a merge when a\r
  59 branch incorporates all the commits since the point they forked. The end result\r
  60 is that git will have a good idea of how far branches have diverged. So the\r
  61 import process does lose some patch-trading metadata.</simpara>\r
  62 <simpara>Fortunately, when you try and merge branches imported from Arch,\r
  63 git will find a good merge base, and it has a good chance of identifying\r
  64 patches that have been traded out-of-sequence between the branches.</simpara>\r
  65 </simplesect>\r
  66 <simplesect id="_options">\r
  67 <title>OPTIONS</title>\r
  68 <variablelist>\r
  69 <varlistentry>\r
  70 <term>\r
  71 -h\r
  72 </term>\r
  73 <listitem>\r
  74 <simpara>\r
  75         Display usage.\r
  76 </simpara>\r
  77 </listitem>\r
  78 </varlistentry>\r
  79 <varlistentry>\r
  80 <term>\r
  81 -v\r
  82 </term>\r
  83 <listitem>\r
  84 <simpara>\r
  85         Verbose output.\r
  86 </simpara>\r
  87 </listitem>\r
  88 </varlistentry>\r
  89 <varlistentry>\r
  90 <term>\r
  91 -T\r
  92 </term>\r
  93 <listitem>\r
  94 <simpara>\r
  95         Many tags. Will create a tag for every commit, reflecting the commit\r
  96         name in the Arch repository.\r
  97 </simpara>\r
  98 </listitem>\r
  99 </varlistentry>\r
 100 <varlistentry>\r
 101 <term>\r
 102 -f\r
 103 </term>\r
 104 <listitem>\r
 105 <simpara>\r
 106         Use the fast patchset import strategy.  This can be significantly\r
 107         faster for large trees, but cannot handle directory renames or\r
 108         permissions changes.  The default strategy is slow and safe.\r
 109 </simpara>\r
 110 </listitem>\r
 111 </varlistentry>\r
 112 <varlistentry>\r
 113 <term>\r
 114 -o\r
 115 </term>\r
 116 <listitem>\r
 117 <simpara>\r
 118         Use this for compatibility with old-style branch names used by\r
 119         earlier versions of <emphasis>git archimport</emphasis>.  Old-style branch names\r
 120         were category&#45;&#45;branch, whereas new-style branch names are\r
 121         archive,category&#45;&#45;branch&#45;&#45;version.  In both cases, names given\r
 122         on the command-line will override the automatically-generated\r
 123         ones.\r
 124 </simpara>\r
 125 </listitem>\r
 126 </varlistentry>\r
 127 <varlistentry>\r
 128 <term>\r
 129 -D &lt;depth&gt;\r
 130 </term>\r
 131 <listitem>\r
 132 <simpara>\r
 133         Follow merge ancestry and attempt to import trees that have been\r
 134         merged from.  Specify a depth greater than 1 if patch logs have been\r
 135         pruned.\r
 136 </simpara>\r
 137 </listitem>\r
 138 </varlistentry>\r
 139 <varlistentry>\r
 140 <term>\r
 141 -a\r
 142 </term>\r
 143 <listitem>\r
 144 <simpara>\r
 145         Attempt to auto-register archives at <ulink url="http://mirrors.sourcecontrol.net">http://mirrors.sourcecontrol.net</ulink>\r
 146         This is particularly useful with the -D option.\r
 147 </simpara>\r
 148 </listitem>\r
 149 </varlistentry>\r
 150 <varlistentry>\r
 151 <term>\r
 152 -t &lt;tmpdir&gt;\r
 153 </term>\r
 154 <listitem>\r
 155 <simpara>\r
 156         Override the default tempdir.\r
 157 </simpara>\r
 158 </listitem>\r
 159 </varlistentry>\r
 160 <varlistentry>\r
 161 <term>\r
 162 &lt;archive/branch&gt;\r
 163 </term>\r
 164 <listitem>\r
 165 <simpara>\r
 166         Archive/branch identifier in a format that <emphasis>tla log</emphasis> understands.\r
 167 </simpara>\r
 168 </listitem>\r
 169 </varlistentry>\r
 170 </variablelist>\r
 171 </simplesect>\r
 172 <simplesect id="_git">\r
 173 <title>GIT</title>\r
 174 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 175 </simplesect>\r
 176 </article>\r