summaryrefslogtreecommitdiff
path: root/docs/manpages/gbp-clone.sgml
blob: 49418ac7d4574b937ead870f429284fc716819b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<refentry id="man.gbp.clone">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
   <refentrytitle>gbp-clone</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>gbp-clone</refname>

    <refpurpose>Clone a repository from remote</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-clone;

      &man.common.options.synopsis;
      <arg><option>--all</option></arg>
      <arg><option>--[no-]pristine-tar</option></arg>
      <group>
        <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
        <arg><option>--packaging-branch=</option><replaceable>branch_name</replaceable></arg>
      </group>
      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--depth=</option><replaceable>depth</replaceable></arg>
      <arg choice="plain"><replaceable>remote_uri</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
    &gbp-clone; clones a remote repository and sets up tracking branches for
    the <emphasis>debian</emphasis>, <emphasis>upstream</emphasis> and
    <emphasis>pristine-tar</emphasis> branches. This way you can easily update
    later using &gbp-pull;.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      &man.common.options.description;

      <varlistentry>
        <term><option>--all</option>
        </term>
        <listitem>
	  <para>Track all branches, not only <replaceable>debian</replaceable>
	  and <replaceable>upstream</replaceable>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>The branch in the Git repository the Debian package is being
	  developed on, default is <replaceable>master</replaceable>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--packaging-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
          <para>The branch the packaging is being maintained on.
          Alternative to the <emphasis>--debian-branch</emphasis> option.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>The branch in the &git; repository the upstream sources are put
	  onto. Default is <replaceable>upstream</replaceable>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--depth</option>=<replaceable>depth</replaceable>
        </term>
        <listitem>
          <para>Git history depth, for creating shallow git clones.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--pristine-tar</option>
        </term>
        <listitem>
          <para>Track pristine tar branch.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
      &man.gbp.config-files;
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <xref linkend="man.gbp.buildpackage">,
      <xref linkend="man.gbp.pull">,
      <xref linkend="man.gbp.conf">
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhusername; &dhemail;</para>

  </refsect1>
</refentry>