summaryrefslogtreecommitdiffhomepage
path: root/docs/manpages/gbp-clone.sgml
blob: 28c6ec0c5d8d48eb5b8c7f12539764756c2b9797 (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<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>
      <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--depth=</option><replaceable>depth</replaceable></arg>
      <arg><option>--reference=</option><replaceable>repository</replaceable></arg>
      <arg><option>--postclone=</option><replaceable>COMMAND</replaceable></arg>
      <arg><option>--[no-]hooks</option></arg>
      <arg choice="plain"><replaceable>repository</replaceable></arg>
      <arg><replaceable>directory</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>--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>--reference</option>=<replaceable>repository</replaceable>
        </term>
        <listitem>
          <para>Local repository to use as alternate instead of re-copying data from remote repository.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--pristine-tar</option>
        </term>
        <listitem>
          <para>Track pristine tar branch.</para>
        </listitem>
      </varlistentry>
    </variablelist>
    <variablelist>
      <varlistentry>
	<term><option>--[no-]hooks</option></term>
	<listitem>
          <para>
            Enable running hooks.
          </para>
	</listitem>
      </varlistentry>
    </variablelist>
    <variablelist>
      <varlistentry>
	<term><option>--postclone=</option><replaceable>COMMAND</replaceable></term>
	<listitem>
          <para>
            Execute <replaceable>COMMAND</replaceable> after cloning the source
            from the remote.
          </para>
          <para>
            Exported environment variables are: <envar>GBP_GIT_DIR</envar> (the
            repository the package is being built from).
          </para>
	  <para>Note that if you clone a repository that contains a
	    hook configuration in <filename>debian/gbp.conf</filename>
	    this hook will not be run automatically to prevent execution
	    of untrusted code.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
    <variablelist>
      <varlistentry>
	<term><replaceable>repository</replaceable></term>
	<listitem>
          <para>
	    The (possibly remote) repository to clone from.
          </para>
	</listitem>
      </varlistentry>
    </variablelist>
    <variablelist>
      <varlistentry>
	<term><replaceable>directory</replaceable></term>
	<listitem>
          <para>
	    The directory to clone to.
          </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
    <refsect1>
    <title>EXAMPLES</title>
    <para>
      Clone a repository and setup a tracking branch for pristine-tar
      as well:
    </para>
    <screen>
      &gbp-clone; --pristine-tar git://honk.sigxcpu.org/git/git-buildpackage.git
    </screen>
  </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>