summaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2013-06-26 13:09:51 +0200
committerGuido Günther <agx@sigxcpu.org>2013-06-26 13:31:27 +0200
commit1d90e73e969cebc1aaa6a151dd03da0b271fbb4d (patch)
tree9d0908fc6d625c81f14d89126ba733b952016dfa /docs/manpages
parentdaccfa00121dcedf0b20d846f2263f3e30b457c6 (diff)
docs: Rename the entities from &git-<command>; to &gbp-<command>;
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/gbp.conf.sgml2
-rw-r--r--docs/manpages/git-buildpackage.sgml10
-rw-r--r--docs/manpages/git-dch.sgml18
-rw-r--r--docs/manpages/git-import-dsc.sgml6
-rw-r--r--docs/manpages/git-import-dscs.sgml10
-rw-r--r--docs/manpages/git-import-orig.sgml8
6 files changed, 27 insertions, 27 deletions
diff --git a/docs/manpages/gbp.conf.sgml b/docs/manpages/gbp.conf.sgml
index b800a96..4ffa116 100644
--- a/docs/manpages/gbp.conf.sgml
+++ b/docs/manpages/gbp.conf.sgml
@@ -56,7 +56,7 @@
key = value
[&lt;command&gt;]
- # Specific sections for each command, like &git-buildpackage;
+ # Specific sections for each command, like &gbp-buildpackage;
key = value
[remote-config &lt;name&gt;]
diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml
index 88e26c0..4660f5f 100644
--- a/docs/manpages/git-buildpackage.sgml
+++ b/docs/manpages/git-buildpackage.sgml
@@ -19,7 +19,7 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- &git-buildpackage;
+ &gbp-buildpackage;
<arg><option>--git-[no-]ignore-new</option></arg>
<arg><option>--git-tag</option></arg>
<arg><option>--git-verbose</option></arg>
@@ -64,10 +64,10 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-buildpackage; is used to build Debian source and .deb packages from a &git; repository.
+ &gbp-buildpackage; is used to build Debian source and .deb packages from a &git; repository.
</para>
<para>
- &git-buildpackage; will, in order:
+ &gbp-buildpackage; will, in order:
</para>
<itemizedlist>
<listitem><para>Verify that it is being executed from the
@@ -88,7 +88,7 @@
(or the application specified via <option>--git-builder</option>)
with arguments instructing it to ignore &git; meta-data in
the diff.gz, passing along all arguments given to
- &git-buildpackage; that don't start with --git-.
+ &gbp-buildpackage; that don't start with --git-.
</para>
</listitem>
<listitem><para>
@@ -216,7 +216,7 @@
<term><option>--git-debian-branch</option>=<replaceable>branch_name</replaceable>
</term>
<listitem>
- <para>If you're not on this branch when invoking &git-buildpackage;
+ <para>If you're not on this branch when invoking &gbp-buildpackage;
it will fail. Default is <replaceable>master</replaceable>. This is
done to make sure you don't accidentally release from a topic branch.
Not being on this branch will be ignored when using
diff --git a/docs/manpages/git-dch.sgml b/docs/manpages/git-dch.sgml
index d1256a6..7e550f3 100644
--- a/docs/manpages/git-dch.sgml
+++ b/docs/manpages/git-dch.sgml
@@ -19,7 +19,7 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- &git-dch;
+ &gbp-dch;
<arg><option>--verbose</option></arg>
<arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -63,20 +63,20 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-dch; reads git commit messages and generates the Debian changelog from
- it. If no arguments are given &git-dch; starts from the last tagged Debian
+ &gbp-dch; reads git commit messages and generates the Debian changelog from
+ it. If no arguments are given &gbp-dch; starts from the last tagged Debian
package version up to the current tip of the current branch. If the
distribution of the topmost section in
<filename>debian/changelog</filename> is <emphasis>UNRELEASED</emphasis>
the changelog entries will be inserted into this section. Otherwise a new
section will be created.</para>
- <para>If <option>--auto</option> is given &git-dch; tries to guess the
+ <para>If <option>--auto</option> is given &gbp-dch; tries to guess the
last &git; commit documented in the changelog - this only works in snapshot
- mode. Otherwise <option>--since</option> can be used to tell &git-dch;
+ mode. Otherwise <option>--since</option> can be used to tell &gbp-dch;
at which point it should start in the &git; history.</para>
<para>
The additional path arguments can be used to restrict the repository paths
- &git-dch; looks at. Setting <replaceable>path</replaceable> to
+ &gbp-dch; looks at. Setting <replaceable>path</replaceable> to
<emphasis>debian/</emphasis> is a good choice if upstream uses &git; and
all Debian packaging changes are restricted to the
<replaceable>debian/</replaceable> subdir. In more sophisticated cases
@@ -321,14 +321,14 @@
Snapshot mode can be used for quick test and install cycles without
having to worry about version numbers or changelog entries.
</para><para>
- When using <option>--snapshot</option> or <option>-S</option> &git-dch;
+ When using <option>--snapshot</option> or <option>-S</option> &gbp-dch;
uses a pseudo header in the Debian changelog to remember the last git
commit it added a changelog entry for. It also sets a version number
ending in
<replaceable>~&lt;snaspshotnumber&gt;.gbp&lt;commitid&gt;</replaceable>.
It automatically increments the snapshot number on subsequent invocations
- of &git-dch; <option>-S</option> so that later snapshots automatically
- have a higher version number. To leave snapshot mode invoke &git-dch;
+ of &gbp-dch; <option>-S</option> so that later snapshots automatically
+ have a higher version number. To leave snapshot mode invoke &gbp-dch;
with the <option>--release</option> option. This removes the pseudo
header and unmangles the version number so the released version has a
higher version number than the snapshots.
diff --git a/docs/manpages/git-import-dsc.sgml b/docs/manpages/git-import-dsc.sgml
index 3a55123..221288f 100644
--- a/docs/manpages/git-import-dsc.sgml
+++ b/docs/manpages/git-import-dsc.sgml
@@ -19,7 +19,7 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- &git-import-dsc;
+ &gbp-import-dsc;
<arg><option>--verbose</option></arg>
<arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -37,7 +37,7 @@
<arg choice="plain"><replaceable>debian-source.dsc</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
- &git-import-dsc;
+ &gbp-import-dsc;
<arg><option>options</option></arg>
<arg choice="req"><option>--download</option></arg>
@@ -51,7 +51,7 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-import-dsc; imports a Debian source package into a &git; repository,
+ &gbp-import-dsc; imports a Debian source package into a &git; repository,
notes the package version in the commit logs, and commits the change. All
information, including package name, version, Debian diffs, and upstream
source is automatically detected from the source package.
diff --git a/docs/manpages/git-import-dscs.sgml b/docs/manpages/git-import-dscs.sgml
index 881c1a3..b494e29 100644
--- a/docs/manpages/git-import-dscs.sgml
+++ b/docs/manpages/git-import-dscs.sgml
@@ -19,7 +19,7 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- &git-import-dscs;
+ &gbp-import-dscs;
<arg><option>options</option></arg>
<arg><option>git-import-dsc options</option></arg>
<arg choice="plain"><replaceable>pkg_1.dsc</replaceable></arg>
@@ -30,7 +30,7 @@
<para>or</para>
<cmdsynopsis>
- &git-import-dscs;
+ &gbp-import-dscs;
<arg choice="req">--debsnap</arg>
<arg><option>options</option></arg>
<arg><option>git-import-dsc options</option></arg>
@@ -40,9 +40,9 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-import-dscs; imports several versions of a Debian source package into
+ &gbp-import-dscs; imports several versions of a Debian source package into
a &git; repository. To do so it sorts the packages by their versions first
- and then imports them via calling &git-import-dsc; on each package.
+ and then imports them via calling &gbp-import-dsc; on each package.
</para>
<para>
@@ -73,7 +73,7 @@ options shipped in the package source.</para>
</varlistentry>
</variablelist>
<para>
- All other options are passed on verbatim to &git-import-dsc;.
+ All other options are passed on verbatim to &gbp-import-dsc;.
</para>
</refsect1>
<refsect1>
diff --git a/docs/manpages/git-import-orig.sgml b/docs/manpages/git-import-orig.sgml
index 54c584e..e8ce68e 100644
--- a/docs/manpages/git-import-orig.sgml
+++ b/docs/manpages/git-import-orig.sgml
@@ -19,7 +19,7 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- &git-import-orig;
+ &gbp-import-orig;
<arg><option>--verbose</option></arg>
<arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
@@ -45,7 +45,7 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- &git-import-orig; imports <replaceable>upstream-source</replaceable> into
+ &gbp-import-orig; imports <replaceable>upstream-source</replaceable> into
the &git; repository. <replaceable>upstream-source</replaceable> can either
be a gzip, bzip2, lzma or xz compressed tar archive, a zip archive or an
already unpacked source tree. If it is already of the form
@@ -53,7 +53,7 @@
information is read from the tarball's filename otherwise it can be
given on the command line via <option>--upstream-version</option>.
If the source package name or version can't be determined
- &git-import-orig; will prompt for it unless <option>--no-interactive</option>
+ &gbp-import-orig; will prompt for it unless <option>--no-interactive</option>
is given.</para>
<para>The sources are placed on the upstream branch (default:
@@ -93,7 +93,7 @@
<listitem>
<para>The branch in the Git repository the Debian package is being
developed on, default is <replaceable>master</replaceable>. After
- importing the new sources on the upstream branch, &git-import-orig;
+ importing the new sources on the upstream branch, &gbp-import-orig;
will try to merge the new version onto this branch.</para>
</listitem>
</varlistentry>