gbp-create-remote-repo.sgml 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. <refentry id="man.gbp.create.remote.repo">
  2. <refentryinfo>
  3. <address>
  4. &dhemail;
  5. </address>
  6. <author>
  7. &dhfirstname;
  8. &dhsurname;
  9. </author>
  10. </refentryinfo>
  11. <refmeta>
  12. <refentrytitle>gbp-create-remote-repo</refentrytitle>
  13. &dhsection;
  14. </refmeta>
  15. <refnamediv>
  16. <refname>gbp-create-remote-repo</refname>
  17. <refpurpose>Create remote repositories</refpurpose>
  18. </refnamediv>
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. &gbp-create-remote-repo;
  22. &man.common.options.synopsis;
  23. <arg><option>--remote-url-pattern=</option><replaceable>url-pattern</replaceable></arg>
  24. <arg><option>--remote-name=</option><replaceable>name</replaceable></arg>
  25. <arg><option>--template-dir=</option><replaceable>directory</replaceable></arg>
  26. <arg><option>--remote-config=</option><replaceable>config</replaceable></arg>
  27. <arg><option>--[no-]pristine-tar</option></arg>
  28. <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
  29. <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
  30. <arg><option>--[no-]track</option></arg>
  31. <arg><option>--[no-]bare</option></arg>
  32. <group choice="opt">
  33. <arg><replaceable>create</replaceable></arg>
  34. <arg><replaceable>list</replaceable></arg>
  35. </group>
  36. </cmdsynopsis>
  37. </refsynopsisdiv>
  38. <refsect1>
  39. <title>DESCRIPTION</title>
  40. <para>
  41. &gbp-create-remote-repo; creates a repository at a remote location via ssh
  42. and pushes the local repository into it. It then sets up remote branch
  43. tracking so you can use &gbp-pull; to update your repository from there.
  44. </para>
  45. <para>
  46. Before performing any action on the remote location, it will print the
  47. remote URL and ask for confirmation.
  48. </para>
  49. <para>
  50. Note: By default, the remote repositories are created in the <systemitem
  51. class="groupname">collab-maint</systemitem> repository on <systemitem
  52. class="systemname">git.debian.org</systemitem>.
  53. </para>
  54. <para>
  55. When invoked with <option>list</option> it lists the available
  56. remote config templates.
  57. </para>
  58. </refsect1>
  59. <refsect1>
  60. <title>OPTIONS</title>
  61. <variablelist>
  62. &man.common.options.description;
  63. <varlistentry>
  64. <term><option>--remote-url-pattern</option>=<replaceable>pattern</replaceable>
  65. </term>
  66. <listitem>
  67. <para>Where to create the remote repository. The part
  68. <replaceable>%(pkg)s</replaceable> will be replaced by the package name.
  69. </para>
  70. </listitem>
  71. </varlistentry>
  72. <varlistentry>
  73. <term><option>--remote-name</option>=<replaceable>name</replaceable>
  74. </term>
  75. <listitem>
  76. <para>What name git will use when referring to that repository, e.g.
  77. 'origin'.</para>
  78. </listitem>
  79. </varlistentry>
  80. <varlistentry>
  81. <term><option>--template-dir</option>=<replaceable>directory</replaceable>
  82. </term>
  83. <listitem>
  84. <para>Template directory to pass to <command>git init</command> on the remote
  85. side. This can be used to customize the remote repository, e.g. to set up hooks.
  86. </para>
  87. </listitem>
  88. </varlistentry>
  89. <varlistentry>
  90. <term><option>--remote-config</option>=<replaceable>config</replaceable>
  91. </term>
  92. <listitem>
  93. <para>Name of a config file section in <filename>gbp.conf</filename>
  94. that specifies the above parameters. See <xref linkend="man.gbp.conf"/>
  95. manpage for details.
  96. </para>
  97. </listitem>
  98. </varlistentry>
  99. <varlistentry>
  100. <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
  101. </term>
  102. <listitem>
  103. <para>The branch in the &git; repository the &debian; package is being
  104. developed on, default is <replaceable>master</replaceable>.</para>
  105. </listitem>
  106. </varlistentry>
  107. <varlistentry>
  108. <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
  109. </term>
  110. <listitem>
  111. <para>The branch in the &git; repository the upstream sources are put
  112. onto. Default is <replaceable>upstream</replaceable>.</para>
  113. </listitem>
  114. </varlistentry>
  115. <varlistentry>
  116. <term><option>--pristine-tar</option>
  117. </term>
  118. <listitem>
  119. <para>Whether to push the pristine tar branch.</para>
  120. </listitem>
  121. </varlistentry>
  122. <varlistentry>
  123. <term><option>--[no-]track</option>
  124. </term>
  125. <listitem>
  126. <para>Whether to set up branch tracking for the debian, upstream and
  127. pristine-tar branches.</para>
  128. </listitem>
  129. </varlistentry>
  130. <varlistentry>
  131. <term><option>--[no-]bare</option>
  132. </term>
  133. <listitem>
  134. <para>Whether to the remote repository should be a bare
  135. repository (this is the default).</para>
  136. </listitem>
  137. </varlistentry>
  138. </variablelist>
  139. </refsect1>
  140. <refsect1>
  141. &man.gbp.config-files;
  142. </refsect1>
  143. <refsect1>
  144. <title>SEE ALSO</title>
  145. <para>
  146. <xref linkend="man.gbp.buildpackage"/>,
  147. <xref linkend="man.gbp.pull"/>,
  148. <xref linkend="man.gbp.conf"/>
  149. </para>
  150. </refsect1>
  151. <refsect1>
  152. <title>AUTHOR</title>
  153. <para>&dhusername; &dhemail;</para>
  154. </refsect1>
  155. </refentry>
  156. <!-- LocalWords: ssh
  157. -->