diff options
Diffstat (limited to 'docs/manpages/gbp-clone.sgml')
-rw-r--r-- | docs/manpages/gbp-clone.sgml | 65 |
1 files changed, 64 insertions, 1 deletions
diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml index 8c3cbdb6..28c6ec0c 100644 --- a/docs/manpages/gbp-clone.sgml +++ b/docs/manpages/gbp-clone.sgml @@ -28,7 +28,10 @@ <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 choice="plain"><replaceable>remote_uri</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> @@ -92,6 +95,66 @@ </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; |