[med-svn] r19133 - trunk/community/website/docs
Andreas Tille
tille at moszumanska.debian.org
Tue May 5 06:38:30 UTC 2015
Author: tille
Date: 2015-05-05 06:38:30 +0000 (Tue, 05 May 2015)
New Revision: 19133
Modified:
trunk/community/website/docs/policy.xml
Log:
Do not advertise deprecate git-buildpackage interface any more. Now instead of git-foo the usage is gbp foo.
Modified: trunk/community/website/docs/policy.xml
===================================================================
--- trunk/community/website/docs/policy.xml 2015-05-04 23:24:04 UTC (rev 19132)
+++ trunk/community/website/docs/policy.xml 2015-05-05 06:38:30 UTC (rev 19133)
@@ -139,18 +139,18 @@
<para>
For packages managed with Git, the option <option>--git-track</option>
ensures that the clone has all the branches tracked. This is
- needed when using the <link linkend="git-buildpackage">git-buildpackage</link>
+ needed when using the <link linkend="git-buildpackage">gbp buildpackage</link>
helper. Alternatively to <command>debcheckout</command>, the command
- <command>gbp-clone</command> will also track the relevant branches:<programlisting>
-<command>gbp-clone</command> <replaceable>git+ssh://git.debian.org/git/debian-med/<package>.git</replaceable></programlisting>
+ <command>gbp clone</command> will also track the relevant branches:<programlisting>
+<command>gbp clone</command> <replaceable>git+ssh://git.debian.org/git/debian-med/<package>.git</replaceable></programlisting>
</para>
</listitem>
<listitem>
<para>
For read-only access with <command>debcheckout</command>, remove
- the <option>--user</option> option. With <command>gbp-clone</command>,
+ the <option>--user</option> option. With <command>gbp clone</command>,
use an anonymous URL like the following:<programlisting>
-<command>gbp-clone</command> <replaceable>git://anonscm.debian.org/debian-med/<package>.git</replaceable></programlisting>
+<command>gbp clone</command> <replaceable>git://anonscm.debian.org/debian-med/<package>.git</replaceable></programlisting>
</para>
</listitem>
</itemizedlist>
@@ -298,10 +298,10 @@
but the repositories can be arranged in different possible layouts.
</para>
<sect3 id="git-buildpackage">
- <title><command>git-buildpackage</command></title>
+ <title><command>gbp buildpackage</command></title>
<para>
Most of our packages using Git and stored in Alioth are managed following
- the standard layout of the <command>git-buildpackage</command> helper. The
+ the standard layout of the <command>gbp buildpackage</command> helper. The
<literal>master</literal> branch contains the full source package.
The <literal>upstream</literal> branch contains the upstream source,
after repacking when necessary (non-free files, large convenience code
@@ -315,7 +315,7 @@
tagged with names like <literal>upstream/upstreamversion</literal>.
</para>
<para>
- <command>git-buildpackage</command> can be set to a directory layout
+ <command>gbp buildpackage</command> can be set to a directory layout
similar to the one we use with <command>svn-buildpackage</command> by
using the <literal>export-dir</literal> and <literal>tarball-dir</literal>
options. However those settings should only be in a system-wide or
@@ -338,7 +338,7 @@
<option>-b</option> option.
</para>
<para>
- Even when you are not using <command>git-buildpackage</command>,
+ Even when you are not using <command>gbp buildpackage</command>,
please include a <link linkend="debian-gbp.conf"><filename>debian/gbp.conf</filename></link>,
to document the layout of the repository.
</para>
@@ -384,7 +384,7 @@
<command>git import-orig</command> <option>--pristine-tar</option> <filename>/path/to/package_version.orig.tar.gz</filename>
<command>svn export svn://anonscm.debian.org/svn/debian-med/trunk/package_template debian</command></programlisting>
</para>
- The above steps will create a repository with the appropriate layout for <command>git-buildpackage</command>, with three branches:
+ The above steps will create a repository with the appropriate layout for <command>gbp buildpackage</command>, with three branches:
<literal>master</literal> (where the Debian development will happen),
<literal>pristine-tar</literal> used by the <literal>pristine-tar</literal> tool during the package build process to recreate the original tarball,
and <literal>upstream</literal>, which will contain the upstream source.
@@ -395,7 +395,7 @@
<command>debcheckout</command> command with its
<command><option>--git-track='*'</option></command> option.
</para>
- <para>To update the <literal>upstream</literal>, <literal>master</literal> and <literal>pristine-tar</literal> branches at once, use the <command>gbp-pull</command>.</para>
+ <para>To update the <literal>upstream</literal>, <literal>master</literal> and <literal>pristine-tar</literal> branches at once, use the <command>gbp pull</command>.</para>
</sect3>
<sect3 id="git-track-new-branches">
<title>To track extra upstream branches, simply check them out.</title>
@@ -497,7 +497,7 @@
</para>
</sect3>
<sect3 id="git-pbuilder">
- <title>To make <command>git-buildpackage</command> build the package with <command>pdebuild</command>.</title>
+ <title>To make <command>gbp buildpackage</command> build the package with <command>pdebuild</command>.</title>
<para>
Add the following to the configuration file
<filename>~/.gbp.conf</filename> or
@@ -505,7 +505,7 @@
[DEFAULT]
builder = ~/bin/git-pbuilder</programlisting>
With this configuration file you're specifying that
- <command>git-buildpackage</command> will use
+ <command>gbp buildpackage</command> will use
<filename>~/bin/git-pbuilder</filename> as the builder script.
This is an example script you can use:<programlisting>
#!/bin/sh
@@ -533,7 +533,7 @@
</para>
<itemizedlist>
<listitem>
- <para>Start the conversion as explained in the <ulink url="http://wiki.debian.org/Alioth/Git#ConvertaSVNAliothrepositorytoGit">Alioth/Git</ulink> page of the Debian wiki. To be consistent with a later usage of <command>git-buildpackage</command>, it is preferable to prefix the tag names <quote>debian</quote>. During this conversion, you can take advantage of the file <filename>/trunk/community/infrastructure/comitters</filename> in the Subversion repository, and expand it if necessary.</para>
+ <para>Start the conversion as explained in the <ulink url="http://wiki.debian.org/Alioth/Git#ConvertaSVNAliothrepositorytoGit">Alioth/Git</ulink> page of the Debian wiki. To be consistent with a later usage of <command>gbp buildpackage</command>, it is preferable to prefix the tag names <quote>debian</quote>. During this conversion, you can take advantage of the file <filename>/trunk/community/infrastructure/comitters</filename> in the Subversion repository, and expand it if necessary.</para>
</listitem>
<listitem>
<para>Import of the upstream original tarballs that you find relevant, for instance the ones that were part of a stable release). When this paragraph was written, it was necessary to follow special instruction detailed in <ulink url="http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=471560">bug 471560</ulink>.
@@ -550,13 +550,13 @@
<para>Delete the package in the Subversion repository after its VCS URL in Stable has been updated by the next release.</para>
</listitem>
</itemizedlist>
- <para>It is also possible to prepare a Git repository containing some of the package's history using the command <command>git-import-dscs --debsnap</command> from the helper toolkit <command>git-buildpackage</command>. This will download all the versions of a package available in <ulink url="http://snapshot.debian.org">snapshots.debian.org</ulink> and create tags for each of them. Note that as this paragraph is written, the tool is not aware that <emphasis>backports</emphasis> should be a different branch</para>
+ <para>It is also possible to prepare a Git repository containing some of the package's history using the command <command>gbp import-dscs --debsnap</command> from the helper toolkit <command>gbp buildpackage</command>. This will download all the versions of a package available in <ulink url="http://snapshot.debian.org">snapshots.debian.org</ulink> and create tags for each of them. Note that as this paragraph is written, the tool is not aware that <emphasis>backports</emphasis> should be a different branch</para>
</sect2>
<sect2 id="updating-git-package">
<title>Updating a source package managed with Git</title>
- <para>Most source packages maintained as Git repositories in Debian Med are using the <command>git-buildpackage</command> helper toolkit. In doubt, try this one first.</para>
- <para><command>git-buildpackage</command>'s command <command>git-import-orig</command> makes it easy to update of the <emphasis>upstream</emphasis> branch using upstream releases distributed as a compressed archive, and to merge these changes in the <emphasis>master</emphasis> branch. Its option <command>--pristine-tar</command> is useful for stabilizing the MD5 sum of the “<filename>orig.tar.gz</filename>” produced when building a source package from the repository alone (not doing so results in archive rejection of package updates). With recent versions of git-buildpackage, it is often unnecessary to rename the freshly downloaded original upstream archive.</para>
- <para>If you do not use git-buildpackage, please use <command>pristine-tar</command> anyway to register the compressed archives that you upload to Debian as original upstream sources (the <literal>orig.tar.{gz|bz2|xz}</literal> file), with a command such as the following, where <literal>tarball</literal> is a path to the archive file and <literal>tag</literal> is the upstream release tag for that archive (as a fallback, if you created the tarball from a given branch, use the name of the branch).<programlisting>
+ <para>Most source packages maintained as Git repositories in Debian Med are using the <command>gbp buildpackage</command> helper toolkit. In doubt, try this one first.</para>
+ <para><command>gbp buildpackage</command>'s command <command>gbp import-orig</command> makes it easy to update of the <emphasis>upstream</emphasis> branch using upstream releases distributed as a compressed archive, and to merge these changes in the <emphasis>master</emphasis> branch. Its option <command>--pristine-tar</command> is useful for stabilizing the MD5 sum of the “<filename>orig.tar.gz</filename>” produced when building a source package from the repository alone (not doing so results in archive rejection of package updates). With recent versions of <command>gbp buildpackage</command>, it is often unnecessary to rename the freshly downloaded original upstream archive.</para>
+ <para>If you do not use <command>gbp buildpackage</command>, please use <command>pristine-tar</command> anyway to register the compressed archives that you upload to Debian as original upstream sources (the <literal>orig.tar.{gz|bz2|xz}</literal> file), with a command such as the following, where <literal>tarball</literal> is a path to the archive file and <literal>tag</literal> is the upstream release tag for that archive (as a fallback, if you created the tarball from a given branch, use the name of the branch).<programlisting>
<code><command>pristine-tar commit</command> <option>tarball</option> <option>tag</option></code>
</programlisting></para>
<para>Commit messages are sent to our commit mailing list with the <ulink
@@ -774,7 +774,7 @@
<title><filename>debian/gbp.conf</filename></title>
<para>
Include this file to document the layout of the repository. Packages managed
- with <command>git-buildpackage</command> may omit default values.<programlisting>
+ with <command>gbp buildpackage</command> may omit default values.<programlisting>
[DEFAULT]
# The default name for the upstream branch is "upstream".
# Change it if the name is different (for instance, "master").
@@ -782,8 +782,8 @@
# The default name for the Debian branch is "master".
# Change it if the name is different (for instance, "debian/unstable").
debian-branch = master
-# git-import-orig uses the following names for the upstream tags.
-# Change the value if you are not using git-import-orig
+# gbp import-orig uses the following names for the upstream tags.
+# Change the value if you are not using gbp import-orig
upstream-tag = upstream/%(version)s
# Always use pristine-tar.
pristine-tar = True</programlisting>
@@ -875,7 +875,7 @@
</para>
<para>
Git repositories managed with a helper tool should announce it. For
- instance, to show that <command>git-buildpackage</command> is used,
+ instance, to show that <command>gbp buildpackage</command> is used,
the package can contain a configuration file in
<filename>debian/gbp.conf</filename>.
</para>
More information about the debian-med-commit
mailing list