gbp-clone.sgml 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <refentry id="man.gbp.clone">
  2. <refentryinfo>
  3. <address>
  4. &dhemail;
  5. </address>
  6. <author>
  7. &dhfirstname;
  8. &dhsurname;
  9. </author>
  10. </refentryinfo>
  11. <refmeta>
  12. <refentrytitle>gbp-clone</refentrytitle>
  13. &dhsection;
  14. </refmeta>
  15. <refnamediv>
  16. <refname>gbp-clone</refname>
  17. <refpurpose>Clone a repository from remote</refpurpose>
  18. </refnamediv>
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. &gbp-clone;
  22. &man.common.options.synopsis;
  23. <arg><option>--all</option></arg>
  24. <arg><option>--[no-]pristine-tar</option></arg>
  25. <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
  26. <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
  27. <arg><option>--depth=</option><replaceable>depth</replaceable></arg>
  28. <arg><option>--reference=</option><replaceable>repository</replaceable></arg>
  29. <arg choice="plain"><replaceable>remote_uri</replaceable></arg>
  30. </cmdsynopsis>
  31. </refsynopsisdiv>
  32. <refsect1>
  33. <title>DESCRIPTION</title>
  34. <para>
  35. &gbp-clone; clones a remote repository and sets up tracking branches for
  36. the <emphasis>debian</emphasis>, <emphasis>upstream</emphasis> and
  37. <emphasis>pristine-tar</emphasis> branches. This way you can easily update
  38. later using &gbp-pull;.
  39. </para>
  40. </refsect1>
  41. <refsect1>
  42. <title>OPTIONS</title>
  43. <variablelist>
  44. &man.common.options.description;
  45. <varlistentry>
  46. <term><option>--all</option>
  47. </term>
  48. <listitem>
  49. <para>Track all branches, not only <replaceable>debian</replaceable>
  50. and <replaceable>upstream</replaceable>.</para>
  51. </listitem>
  52. </varlistentry>
  53. <varlistentry>
  54. <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
  55. </term>
  56. <listitem>
  57. <para>The branch in the Git repository the Debian package is being
  58. developed on, default is <replaceable>master</replaceable>.</para>
  59. </listitem>
  60. </varlistentry>
  61. <varlistentry>
  62. <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
  63. </term>
  64. <listitem>
  65. <para>The branch in the &git; repository the upstream sources are put
  66. onto. Default is <replaceable>upstream</replaceable>.</para>
  67. </listitem>
  68. </varlistentry>
  69. <varlistentry>
  70. <term><option>--depth</option>=<replaceable>depth</replaceable>
  71. </term>
  72. <listitem>
  73. <para>Git history depth, for creating shallow git clones.</para>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry>
  77. <term><option>--reference</option>=<replaceable>repository</replaceable>
  78. </term>
  79. <listitem>
  80. <para>Local repository to use as alternate instead of re-copying data from remote repository.</para>
  81. </listitem>
  82. </varlistentry>
  83. <varlistentry>
  84. <term><option>--pristine-tar</option>
  85. </term>
  86. <listitem>
  87. <para>Track pristine tar branch.</para>
  88. </listitem>
  89. </varlistentry>
  90. </variablelist>
  91. </refsect1>
  92. <refsect1>
  93. &man.gbp.config-files;
  94. </refsect1>
  95. <refsect1>
  96. <title>SEE ALSO</title>
  97. <para>
  98. <xref linkend="man.gbp.buildpackage"/>,
  99. <xref linkend="man.gbp.pull"/>,
  100. <xref linkend="man.gbp.conf"/>
  101. </para>
  102. </refsect1>
  103. <refsect1>
  104. <title>AUTHOR</title>
  105. <para>&dhusername; &dhemail;</para>
  106. </refsect1>
  107. </refentry>