make the documented command line arguments match reality
authorGuido Guenther <agx@sigxcpu.org>
Thu, 24 May 2007 07:38:30 +0000 (09:38 +0200)
committerGuido Guenther <agx@bogon.sigxcpu.org>
Thu, 24 May 2007 07:38:30 +0000 (09:38 +0200)
docs/chapters/import.sgml
docs/manpages/git-buildpackage.sgml
docs/manpages/git-import-dsc.sgml
docs/manpages/git-import-orig.sgml

index 8ba17190f6f8eb34c02de32b2cedf9d2e6c78068..1420999f0b2106be24adbc8fcd8c09f5ae1398f8 100644 (file)
     <sect1 id="gbp.import.new.upstream">
     <title>Importing a new upstream version</title>
     <para>Change into your git repository, make sure it has all local
-    modifications committed and do:
+    modifications committed and run either of:
     <screen>
 &git-import-orig; /path/to/package_0.2.orig.tar.gz
+&git-import-orig; /path/to/package_0.2.tar.bz2
+&git-import-orig; /path/to/package-0.2/
     </screen>
-    This puts the upstream souces onto the <emphasis>upsream</emphasis> branch
-    using &git_load_dirs; to handle file removals and renames. The result of
+    This puts the upstream souces onto the <emphasis>upstream</emphasis> branch
+    using &gitloaddirs; to handle file removals and renames. The result of
     this is then merged onto the <emphasis>master</emphasis> branch and a new
-    changelog entry gets created. You can again specify different branch names
+    changelog entry is created. You can again specify different branch names
     via the <option>--upstream-branch</option> and
     <option>--debian-branch</option> options.
+    </para> 
+    <para>
+    If you expect a merge conflict you can delay the merge to
+    <emphasis>master</emphasis> via the <option>--no-merge</option> and pull in
+    the changes from the <emphasis>upstream</emphasis> branch any time later.
+    </para>
+    <para>
     </para>
     </sect1>
     <sect1 id="gbp.import.convert">
index 547f1e5148c39d7b58e2feb124839def472e89c5..ae8eadf485eef20da5ff5a164a924c0d307f0a44 100644 (file)
@@ -22,8 +22,8 @@
       <arg><option>--git-ignore-new</option></arg>
       <arg><option>--git-tag</option></arg>
       <arg><option>--git-verbose</option></arg>
-      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
-      <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
+      <arg><option>--git-upstream-branch=</option><replaceable>branch_name</replaceable></arg>
+      <arg><option>--git-debian-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--git-builder=</option><replaceable>BUILD_CMD</replaceable></arg>
       <arg><option>--git-cleaner=</option><replaceable>CLEAN_CMD</replaceable></arg>
       <arg><option>--git-sign-tags</option></arg>
index 559e01aa8d0ce5d05f5289e5a320def13560a55a..1af9d7749ba27b99aeb29df45947a8651924fd30 100644 (file)
@@ -52,8 +52,8 @@
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--verbose</option>, <option>-v</option>
-        </term>
+        <term><option>--verbose</option></term>
+       <term><option>-v</option></term>
         <listitem>
           <para>verbose execution</para>
         </listitem>
index 4853e78ae1e5ba565c56817750ee074260dda9d2..a28047ec65ed70c74b3b1685ed3284259c4782b1 100644 (file)
@@ -22,6 +22,8 @@
       &git-import-orig;
 
       <arg><option>--verbose</option></arg>
+      <arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
+      <arg><option>--no-merge</option></arg>
       <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
       <arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
   <refsect1>
     <title>DESCRIPTION</title>
     <para>
-    &git-import-orig; imports the tar.gz archive given by
-    <replaceable>upstream-source</replaceable> into the &git; repository. If
-    <replaceable>upstream-source</replaceable> is already of the form
-    <replaceable>package-name_version.orig.tar.gz</replaceable>, it reads the
-    version information from the tarball's filename otherwise it can be
-    specified on the commandline via <option>--upstream-version</option>.
+    &git-import-orig; imports <replaceable>upstream-source</replaceable> into
+    the &git; repository. <replaceable>upstream-source</replaceable> can either
+    be a gzip or bzip2 compressed tar archive or an alreay unpacked source
+    tree. If it is already of the form
+    <replaceable>package-name_version.orig.tar.gz</replaceable>, the version
+    information is read from the tarball's filename otherwise it can be
+    given on the command line via <option>--upstream-version</option>.
    
-    When importing the new version <command>git_load_dirs</command> is being
-    used to detect file renames and removals.
+    Upon import <command>git_load_dirs</command> is being used to detect file
+    renames and removals.
     </para>
   </refsect1>
   <refsect1>
 
     <variablelist>
       <varlistentry>
-        <term><option>--upstream-version</option>=<replaceable>version</replaceable>,
-        <option>-u</option><replaceable>version</replaceable></term>
+        <term><option>--upstream-version</option>=<replaceable>version</replaceable></term>
+        <term><option>-u</option><replaceable>version</replaceable></term>
         <listitem>
          <para>The upstream version number</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--no-merge</option></term>
+        <listitem>
+         <para>Don't merge the upstream version to the development branch</para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
         </term>
@@ -75,8 +84,8 @@
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--verbose</option>, <option>-v</option>
-        </term>
+        <term><option>--verbose</option></term> 
+       <term><option>-v</option></term>
         <listitem>
           <para>verbose execution</para>
         </listitem>