gbp-import-srpm.sgml 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <refentry id="man.gbp.import.srpm">
  2. <refentryinfo>
  3. <address>
  4. &rpm-email;
  5. </address>
  6. <author>
  7. &rpm-firstname;
  8. &rpm-surname;
  9. </author>
  10. </refentryinfo>
  11. <refmeta>
  12. <refentrytitle>gbp-import-srpm</refentrytitle>
  13. &rpm-mansection;
  14. </refmeta>
  15. <refnamediv>
  16. <refname>gbp-import-srpm</refname>
  17. <refpurpose>Import source RPM packages into a Git repository</refpurpose>
  18. </refnamediv>
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. &gbp-import-srpm;
  22. &man.common.options.synopsis;
  23. <arg><option>--vendor</option>=<replaceable>VENDOR</replaceable></arg>
  24. <arg><option>--allow-same-versions</option></arg>
  25. <arg><option>--author-is-committer</option></arg>
  26. <arg><option>--packaging-branch=</option><replaceable>BRANCH-NAME</replaceable></arg>
  27. <arg><option>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable></arg>
  28. <arg><option>--download</option></arg>
  29. <arg><option>--packaging-dir=</option><replaceable>DIRECTORY</replaceable></arg>
  30. <arg><option>--filter=</option><replaceable>PATTERN</replaceable></arg>
  31. <arg><option>--keyid=</option><replaceable>GPG-KEYID</replaceable></arg>
  32. <arg><option>--[no-]create-missing-branches</option></arg>
  33. <arg><option>--[no-]pristine-tar</option></arg>
  34. <arg><option>--[no-]sign-tags</option></arg>
  35. <arg><option>--upstream-branch=</option><replaceable>BRANCH-NAME</replaceable></arg>
  36. <arg><option>--upstream-tag=</option><replaceable>TAG-FORMAT</replaceable></arg>
  37. <arg><option>--native</option></arg>
  38. <arg choice="plain"><replaceable>SRPM</replaceable></arg>
  39. </cmdsynopsis>
  40. <cmdsynopsis>
  41. &gbp-import-srpm;
  42. <arg><option>options</option></arg>
  43. <arg choice="req"><option>--download</option></arg>
  44. <group choice="plain">
  45. <arg><replaceable>URL</replaceable></arg>
  46. <arg><replaceable>SRC.RPM</replaceable></arg>
  47. <arg><replaceable>DIRECTORY</replaceable></arg>
  48. </group>
  49. </cmdsynopsis>
  50. </refsynopsisdiv>
  51. <refsect1>
  52. <title>DESCRIPTION</title>
  53. <para>
  54. &gbp-import-srpm; imports an RPM source package into a &git; repository,
  55. notes the package version in the commit logs, and commits the change. All
  56. information, including package name, version and upstream source is
  57. automatically detected from the source package. The tool supports importing
  58. both archived (src.rpm files) or unpacked (directory) source RPMs.
  59. </para>
  60. </refsect1>
  61. <refsect1>
  62. <title>OPTIONS</title>
  63. <variablelist>
  64. &man.common.options.description;
  65. <varlistentry>
  66. <term><option>--vendor</option>=<replaceable>VENDOR</replaceable>
  67. </term>
  68. <listitem>
  69. <para>
  70. Distribution vendor name.
  71. </para>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry>
  75. <term><option>--upstream-branch</option>=<replaceable>BRANCH-NAME</replaceable>
  76. </term>
  77. <listitem>
  78. <para>
  79. The branch in the &git; repository the upstream sources are put
  80. onto. Default is <replaceable>upstream</replaceable>.
  81. </para>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry>
  85. <term><option>--packaging-branch</option>=<replaceable>BRANCH-NAME</replaceable>
  86. </term>
  87. <listitem>
  88. <para>
  89. The branch in the &git; repository the packaging files are put
  90. onto. Default is <replaceable>master</replaceable>.
  91. </para>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry>
  95. <term><option>--[no-]sign-tags</option>
  96. </term>
  97. <listitem>
  98. <para>
  99. GPG sign all created tags.
  100. </para>
  101. </listitem>
  102. </varlistentry>
  103. <varlistentry>
  104. <term><option>--keyid=</option><replaceable>GPG-KEYID</replaceable>
  105. </term>
  106. <listitem>
  107. <para>
  108. Use this keyid for gpg signing tags.
  109. </para>
  110. </listitem>
  111. </varlistentry>
  112. <varlistentry>
  113. <term><option>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable>
  114. </term>
  115. <listitem>
  116. <para>
  117. Use this tag format when tagging released versions,
  118. default is <replaceable>%(vendor)s/%(version)s</replaceable>.
  119. </para>
  120. </listitem>
  121. </varlistentry>
  122. <varlistentry>
  123. <term><option>--upstream-tag=</option><replaceable>TAG-FORMAT</replaceable>
  124. </term>
  125. <listitem>
  126. <para>
  127. Use this tag format when tagging upstream versions,
  128. default is <replaceable>upstream/%(version)s</replaceable>.
  129. </para>
  130. </listitem>
  131. </varlistentry>
  132. <varlistentry>
  133. <term><option>--git-packaging-dir=</option><replaceable>DIRECTORY</replaceable>
  134. </term>
  135. <listitem>
  136. <para>
  137. Subdirectory where to put the RPM packaging files.
  138. </para>
  139. </listitem>
  140. </varlistentry>
  141. <varlistentry>
  142. <term><option>--filter=</option><replaceable>PATTERN</replaceable>
  143. </term>
  144. <listitem>
  145. <para>
  146. Filter out files glob-matching pattern. Can be given multiple times.
  147. </para>
  148. </listitem>
  149. </varlistentry>
  150. <varlistentry>
  151. <term><option>--pristine-tar</option>
  152. </term>
  153. <listitem>
  154. <para>
  155. Generate pristine-tar delta file.
  156. </para>
  157. </listitem>
  158. </varlistentry>
  159. <varlistentry>
  160. <term><option>--download</option>
  161. </term>
  162. <listitem>
  163. <para>
  164. Download the source package instead of looking for it in the local
  165. file system. The argument can either be a plain package name or an
  166. URI. The former uses <command>yumdownloader</command> to download the
  167. source while the later uses &wget;.
  168. </para>
  169. </listitem>
  170. </varlistentry>
  171. <varlistentry>
  172. <term><option>--allow-same-version</option>
  173. </term>
  174. <listitem>
  175. <para>
  176. Allow one to re-import a package with an already existing version.
  177. This will not re-import the upstream sources - only packaging files
  178. will be re-imported.
  179. </para>
  180. </listitem>
  181. </varlistentry>
  182. <varlistentry>
  183. <term><option>--author-is-committer</option>
  184. </term>
  185. <listitem>
  186. <para>
  187. Use the author identity as the comitter when importing upstream
  188. sources and packaging files.
  189. </para>
  190. </listitem>
  191. </varlistentry>
  192. <varlistentry>
  193. <term><option>--[no-]create-missing-branches</option>
  194. </term>
  195. <listitem>
  196. <para>
  197. Create missing upstream and/or packaging branch if missing.
  198. </para>
  199. </listitem>
  200. </varlistentry>
  201. <varlistentry>
  202. <term><option>--orphan-packaging</option>
  203. </term>
  204. <listitem>
  205. <para>
  206. Import packaging files into an orphan branch that will not be based
  207. on the upstream branch. Useful if you want to maintain (non-native)
  208. package using the 'orphan-packaging' model. This option have no
  209. effect if <option>--native</option> is used.
  210. </para>
  211. </listitem>
  212. </varlistentry>
  213. <varlistentry>
  214. <term><option>--native</option>
  215. </term>
  216. <listitem>
  217. <para>
  218. Treat the package as native package. No separate upstream branch or
  219. upstream tags will be created.
  220. </para>
  221. </listitem>
  222. </varlistentry>
  223. </variablelist>
  224. </refsect1>
  225. <refsect1>
  226. &man.gbp.config-files;
  227. </refsect1>
  228. <refsect1>
  229. <title>SEE ALSO</title>
  230. <para>
  231. <xref linkend="man.gbp.buildpackage.rpm"/>,
  232. <xref linkend="man.gbp.pq.rpm"/>,
  233. <xref linkend="man.gbp.conf"/>,
  234. &man.seealso.common;
  235. </para>
  236. </refsect1>
  237. <refsect1>
  238. <title>AUTHOR</title>
  239. <para>
  240. &rpm-username; &rpm-email;
  241. </para>
  242. </refsect1>
  243. </refentry>