diff options
author | Guido Günther <agx@sigxcpu.org> | 2013-06-26 13:09:51 +0200 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2013-06-26 13:31:27 +0200 |
commit | 1d90e73e969cebc1aaa6a151dd03da0b271fbb4d (patch) | |
tree | 9d0908fc6d625c81f14d89126ba733b952016dfa | |
parent | daccfa00121dcedf0b20d846f2263f3e30b457c6 (diff) | |
download | git-buildpackage-1d90e73e969cebc1aaa6a151dd03da0b271fbb4d.tar.gz git-buildpackage-1d90e73e969cebc1aaa6a151dd03da0b271fbb4d.tar.bz2 git-buildpackage-1d90e73e969cebc1aaa6a151dd03da0b271fbb4d.zip |
docs: Rename the entities from &git-<command>; to &gbp-<command>;
-rw-r--r-- | docs/chapters/building.sgml | 30 | ||||
-rw-r--r-- | docs/chapters/cfgfile.sgml | 14 | ||||
-rw-r--r-- | docs/chapters/import.sgml | 44 | ||||
-rw-r--r-- | docs/chapters/intro.sgml | 22 | ||||
-rw-r--r-- | docs/chapters/releases.sgml | 28 | ||||
-rw-r--r-- | docs/chapters/special.sgml | 10 | ||||
-rw-r--r-- | docs/common.ent | 10 | ||||
-rw-r--r-- | docs/manpages/gbp.conf.sgml | 2 | ||||
-rw-r--r-- | docs/manpages/git-buildpackage.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/git-dch.sgml | 18 | ||||
-rw-r--r-- | docs/manpages/git-import-dsc.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/git-import-dscs.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/git-import-orig.sgml | 8 |
13 files changed, 106 insertions, 106 deletions
diff --git a/docs/chapters/building.sgml b/docs/chapters/building.sgml index 159f476c..30296721 100644 --- a/docs/chapters/building.sgml +++ b/docs/chapters/building.sgml @@ -2,7 +2,7 @@ <title>Building packages from the &git; repository</title> <para> In order to build a &debian; package from the &git; repository you use: - &git-buildpackage;. This builds the upstream tarball as will be described below and + &gbp-buildpackage;. This builds the upstream tarball as will be described below and invokes &debuild; to build the package. To use another build command you can use the <option>--git-builder</option> option as described later in the manual but &debuild; is nice since it can invoke <productname>lintian</productname>. @@ -11,9 +11,9 @@ your repository) you'll usually use: </para> <screen> -&git-buildpackage; <option>--git-ignore-new</option> +&gbp-buildpackage; <option>--git-ignore-new</option> </screen> - <para>If &git-buildpackage; doesn't find a valid upstream tarball it will + <para>If &gbp-buildpackage; doesn't find a valid upstream tarball it will create one by looking at the tag matching the upstream version. To change this behaviour see the <option>--git-upstream-tree</option> option. </para><para> @@ -26,7 +26,7 @@ <para>Once you're satisfied with the build and want to do a release you commit all your changes and issue:</para> <screen> -&git-buildpackage; <option>--git-tag</option> +&gbp-buildpackage; <option>--git-tag</option> </screen> <para>This will again build the debian package and tag the final result after extracting the current version from the changelog. If you want &gpg; signed @@ -38,9 +38,9 @@ <sect1 id="gbp.building.export"> <title>Using a separate build dir</title> <para>Tools like &svn-buildpackage; use a separate build-area. To achieve a similar behaviour - with &git-buildpackage; use the <option>--git-export-dir</option> option:</para> + with &gbp-buildpackage; use the <option>--git-export-dir</option> option:</para> <screen> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area/</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area/</replaceable> </screen> <para>This will export the head of the ecurrent branch to <replaceable>../build-area/package-version</replaceable>, build the @@ -48,11 +48,11 @@ <option>--git-export</option> to export any treeish object, here are some examples:</para> <screen> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>debian/0.4.3</replaceable> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>etch</replaceable> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>8caed309653d69b7ab440e3d35abc090eb4c6697</replaceable> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>INDEX</replaceable> -&git-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>WC</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>debian/0.4.3</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>etch</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>8caed309653d69b7ab440e3d35abc090eb4c6697</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>INDEX</replaceable> +&gbp-buildpackage; <option>--git-export-dir</option>=<replaceable>../build-area</replaceable> <option>--git-export</option>=<replaceable>WC</replaceable> </screen> <para>The special argument <replaceable>INDEX</replaceable> exports the state of the current index which can be used to include staged but uncommitted @@ -67,7 +67,7 @@ export-dir=../build-area # to use the same build area for all packages use an absolute path: #export-dir=/home/debian-packages/build-area </programlisting> - &git-buildpackage; will cleanup the build-area after a successful build. If + &gbp-buildpackage; will cleanup the build-area after a successful build. If you want to keep the build tree use <replaceable>--git-no-purge</replaceable>. </para> </sect1> @@ -85,7 +85,7 @@ export-dir=../build-area </para> <sect2 id="gbp.building.lintian"> <title>Running lintian</title> - <para>&git-buildpackage; exports several variables into the + <para>&gbp-buildpackage; exports several variables into the <option>posttag</option>'s environment (for details see the <xref linkend="man.git.buildpackage">). To invoke &lintian; we need to tell it where to find the changes file: @@ -102,7 +102,7 @@ export-dir=../build-area <sect2 id="gbp.building.push"> <title>Pushing into a remote repository</title> <para>If you want to push your changes automatically after a successful build and tag - you can use &git-buildpackage;'s posttag hook. A very simple invocation would look like this: + you can use &gbp-buildpackage;'s posttag hook. A very simple invocation would look like this: <programlisting> <command>git-buildpackage</command> <option>--git-tag</option> <option>--git-posttag</option>=<replaceable>"git push && git push --tags"</replaceable> </programlisting> @@ -153,7 +153,7 @@ echo "done." </sect2> <sect2 id="gbp.building.postexport"> <title>Running postexport hook</title> - <para>&git-buildpackage; exports several variables into the + <para>&gbp-buildpackage; exports several variables into the <option>postexport</option>'s environment (for details see the <xref linkend="man.git.buildpackage">). The motivation for the postexport action is to allow further adjustment of diff --git a/docs/chapters/cfgfile.sgml b/docs/chapters/cfgfile.sgml index 1cbe0b7d..e9c6607d 100644 --- a/docs/chapters/cfgfile.sgml +++ b/docs/chapters/cfgfile.sgml @@ -27,27 +27,27 @@ <variablelist> <varlistentry> <term>[DEFAULT]</term> - <listitem><para>Options in this section apply to &git-buildpackage;, - &git-import-orig;, &git-import-dsc; and &git-dch;.</para></listitem> + <listitem><para>Options in this section apply to &gbp-buildpackage;, + &gbp-import-orig;, &gbp-import-dsc; and &gbp-dch;.</para></listitem> </varlistentry> <varlistentry> <term>[git-buildpackage]</term> - <listitem><para>Options in this section apply to &git-buildpackage; only and override options from the + <listitem><para>Options in this section apply to &gbp-buildpackage; only and override options from the [DEFAULT] section.</para></listitem> </varlistentry> <varlistentry> <term>[git-import-orig]</term> - <listitem><para>Options in this section apply to &git-import-orig; only and override options from the + <listitem><para>Options in this section apply to &gbp-import-orig; only and override options from the [DEFAULT] section.</para></listitem> </varlistentry> <varlistentry> <term>[git-import-dsc]</term> - <listitem><para>Options in this section apply to &git-import-dsc; only and override options from the + <listitem><para>Options in this section apply to &gbp-import-dsc; only and override options from the [DEFAULT] section.</para></listitem> </varlistentry> <varlistentry> <term>[git-dch]</term> - <listitem><para>Options in this section apply to &git-dch; only and override options from the + <listitem><para>Options in this section apply to &gbp-dch; only and override options from the [DEFAULT] section.</para></listitem> </varlistentry> <varlistentry> @@ -62,7 +62,7 @@ <option>upstream-branch</option>=<replaceable>dfsgfree</replaceable> </screen> <para> - in the config file. In the special case of &git-buildpackage; the stripped + in the config file. In the special case of &gbp-buildpackage; the stripped prefix is not '--' but '--git-'. Here's a more complete example: </para> <programlisting> diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml index 6d414218..ddb38715 100644 --- a/docs/chapters/import.sgml +++ b/docs/chapters/import.sgml @@ -5,7 +5,7 @@ <title>Importing already existing &debian; packages</title> <para>Importing an already exsting debian package into a git repository is as easy as: <screen> -&git-import-dsc; package_0.1-1.dsc +&gbp-import-dsc; package_0.1-1.dsc </screen> This will create a new git repository named after the imported package, put the upstream sources onto the <option>upstream-branch</option> and the @@ -26,15 +26,15 @@ &git; repository and just continue with the same command: <screen> cd package/ -&git-import-dsc; package_0.1-2.dsc -&git-import-dsc; package_0.1-3.dsc -&git-import-dsc; package_0.2-1.dsc +&gbp-import-dsc; package_0.1-2.dsc +&gbp-import-dsc; package_0.1-3.dsc +&gbp-import-dsc; package_0.2-1.dsc </screen> </para> <para> -Or you can import all versions at once using &git-import-dscs;: +Or you can import all versions at once using &gbp-import-dscs;: <screen> -&git-import-dscs; /path/to/history/package_*.dsc +&gbp-import-dscs; /path/to/history/package_*.dsc </screen> This will create a &git; repository if necessary and import all versions sorted by version number. @@ -46,9 +46,9 @@ by version number. <para>Change into your git repository (which can be empty), make sure it has all local modifications committed and run either of: <screen> -&git-import-orig; <filename>/path/to/package_0.2.orig.tar.gz</filename> -&git-import-orig; <filename>/path/to/package_0.2.tar.bz2</filename> -&git-import-orig; <filename>/path/to/package-0.2/</filename> +&gbp-import-orig; <filename>/path/to/package_0.2.orig.tar.gz</filename> +&gbp-import-orig; <filename>/path/to/package_0.2.tar.bz2</filename> +&gbp-import-orig; <filename>/path/to/package-0.2/</filename> </screen> This puts the upstream souces onto the <option>upstream-branch</option> and tags them accordingly (the default tag format is @@ -59,7 +59,7 @@ by version number. <option>--debian-branch</option> options. You can also filter out content you don't want imported: <screen> -&git-import-orig; <option>--filter</option>=<replaceable>'CVS/*'</replaceable> <filename>/path/to/package_0.2.orig.tar.gz</filename> +&gbp-import-orig; <option>--filter</option>=<replaceable>'CVS/*'</replaceable> <filename>/path/to/package_0.2.orig.tar.gz</filename> </screen> The <option>--filter</option> option can be used multiple times for more complex filtering. @@ -74,7 +74,7 @@ by version number. (orig.tar.gz) from &git; you should also specify the <option>--pristine-tar</option> option. This is recommended. </para> - <para>To customize the commit message used by &git-import-orig; use + <para>To customize the commit message used by &gbp-import-orig; use the <option>--import-msg</option> option. This string is a standard python format string, into which the <replaceable>version</replaceable> variable is interpolated. (i.e., @@ -86,8 +86,8 @@ by version number. <sect1 id="gbp.import.convert"> <title>Converting an existing &git; repository</title> <para> - If the &git; repository wasn't created with &git-import-dsc; you have to tell - &git-buildpackage; and friends where to find the upstream sources. + If the &git; repository wasn't created with &gbp-import-dsc; you have to tell + &gbp-buildpackage; and friends where to find the upstream sources. </para> <sect2> <title>Upstream sources on a branch</title> @@ -99,7 +99,7 @@ by version number. &gitcmd; branch upstream theupstream-branch &gitcmd; branch <option>-D</option> theupstream-branch </screen> - or you can tell &git-buildpackage; the name of the branch to use as + or you can tell &gbp-buildpackage; the name of the branch to use as <option>upstream-branch</option>: <screen> <command>cat</command> <<EOF > <filename>.git/gbp.conf</filename> @@ -108,7 +108,7 @@ by version number. upstream-branch=theupstream-branch EOF </screen> - If you then use &git-import-orig; to import new upstream sources, they will + If you then use &gbp-import-orig; to import new upstream sources, they will from now on end up on <emphasis>theupstream-branch</emphasis> and merged to the <option>debian-branch</option>. </para> @@ -131,12 +131,12 @@ EOF </para> <warning><para>There's currently no <emphasis>easy</emphasis> way to create the <option>upstream-branch</option> if you never had the upstream sources - as a single commit. Using &git-import-orig; on such repositories might lead + as a single commit. Using &gbp-import-orig; on such repositories might lead to unexpected merge results.</para></warning> <para>In order to fix this you can prepend the upstream sources as a single commit to your tree using &git;'s <ulink url="http://git.or.cz/gitwiki/GraftPoint">grafts</ulink>. Afterwards you - can simply create a branch as explained above and &git-import-orig; will + can simply create a branch as explained above and &gbp-import-orig; will work as expected.</para> <para>Alternatively, if you are only importing source from original tarballs (for instance when converting from a Subversion repository where the @@ -173,7 +173,7 @@ EOF <para>Then you import the upstream sources, branch off the <option>upstream-branch</option> branch and add the debian files (e.g. via dh_make): <screen> -&git-import-orig; <option>-u</option> <replaceable>0.1</replaceable> <filename>../package-0.1.tar.gz</filename> +&gbp-import-orig; <option>-u</option> <replaceable>0.1</replaceable> <filename>../package-0.1.tar.gz</filename> <command>dh_make</command> </screen> That's it, you're done. If you want to publish you're new repository you can use &gbp-create-remote-repo;. @@ -194,7 +194,7 @@ EOF </para> <para> - &git-buildpackage; will by default create an upstream tarball for you. By default it will + &gbp-buildpackage; will by default create an upstream tarball for you. By default it will be created from the tag name given by the <option>--git-upstream-tag</option> option. You can customize it's value via the <option>upstream-tag</option> configuration variable. </para> @@ -211,7 +211,7 @@ upstream-tag = v%(version)s <replaceable>version</replaceable> will be replaced with the upstream version number as read from <filename>debian/changelog</filename>. </para> - <para>If you're using &pristine-tar; you can make &git-buildpackage commit the tarball back to the + <para>If you're using &pristine-tar; you can make &gbp-buildpackage commit the tarball back to the pristine-tar branch by using the <option>--git-pristine-tar-commit</option> option. </para> </sect2> @@ -221,10 +221,10 @@ upstream-tag = v%(version)s <para>If you want to track upstream's git but continue to import the upstream tarballs, e.g. to make sure the tarball uploaded to &debian; has the same checksum as upstream's you can use the <option>--upstream-vcs-tag</option> option - when importing new tarballs with &git-import-orig;. Assuming you have the upstream source in your + when importing new tarballs with &gbp-import-orig;. Assuming you have the upstream source in your repository with a tag <replaceable>v0.0.1</replaceable> you can use: <screen> - &git-import-orig; --upstream-vcs-tag=v0.0.1 foo_0.0.1.orig.tar.gz + &gbp-import-orig; --upstream-vcs-tag=v0.0.1 foo_0.0.1.orig.tar.gz </screen> to add upstream's tag as additional parent to the merge commit. See <ulink url="http://bugs.debian.org/664771">#664771</ulink> for more details. diff --git a/docs/chapters/intro.sgml b/docs/chapters/intro.sgml index 3fdf1f6c..410a9e31 100644 --- a/docs/chapters/intro.sgml +++ b/docs/chapters/intro.sgml @@ -1,7 +1,7 @@ <chapter id="gbp.intro"> <title>Introduction</title> <para> - Welcome to &git-buildpackage;, a system that integrates the + Welcome to &gbp-buildpackage;, a system that integrates the <ulink url="http://www.debian.org/">Debian</ulink> package build system with <ulink url="http://git.or.cz/">Git</ulink>. The current version of this manual can be found at <ulink url="https://honk.sigxcpu.org/piki/projects/git-buildpackage">here</ulink>. @@ -29,7 +29,7 @@ <sect1 id="gbp.repository"> <title>Repository Layout and Terminology</title> <para>The only requirement on the repository layout for using - &git-buildpackage; and friends is, that the branch the debian work is + &gbp-buildpackage; and friends is, that the branch the debian work is being done on is different from the branch the upstream sources are being maintained on (this, of course, has no meaning for Debian native packages). This is necessary to be able to build upstream tarballs and @@ -70,7 +70,7 @@ <para>You're completely free to pick any repository layout and the branch names above are only - &git-buildpackage;'s defaults. They can be changed at any point in time + &gbp-buildpackage;'s defaults. They can be changed at any point in time and you can work with an arbitrary number of branches. For example branches like <emphasis>nmu</emphasis>, <emphasis>bpo</emphasis> or <emphasis>stable</emphasis> might @@ -78,13 +78,13 @@ and branches like <emphasis>dfsg_free</emphasis> or <emphasis>snapshots</emphasis> might become your <option>upstream-branch</option> - it doesn't matter if these branches - are maintained with &git-import-orig; or not.</para> + are maintained with &gbp-import-orig; or not.</para> <para>Since Git-Buildpackage only works with local &git;-repositories you have to use <command>git-push</command> in order to publish your changes to remote repositories like <ulink url="http://git.debian.org/">git.debian.org</ulink>, this can also be - automized with &git-buildpackage;'s <option>post-tag</option> + automized with &gbp-buildpackage;'s <option>post-tag</option> hook.</para> </sect1> @@ -94,24 +94,24 @@ A typical, simple workflow consists of the following steps: </para> <orderedlist> - <listitem><para>Import a new Debian package via &git-import-dsc;. This + <listitem><para>Import a new Debian package via &gbp-import-dsc;. This imports the &debian; Package on the <option>debian-branch</option> and the upstream sources on the <option>upstream-branch</option>.</para></listitem> <listitem><para>Develop, test, commit changes. During this time you can - always build the package with &git-buildpackage;. In case you have + always build the package with &gbp-buildpackage;. In case you have uncommitted changes in your source tree you can use the <option>--git-ignore-new</option> option.</para></listitem> <listitem><para>Optionally you can create the Debian changelog entries - using &git-dch; and create snapshot releases for testing using its + using &gbp-dch; and create snapshot releases for testing using its <option>--snapshot</option> option.</para></listitem> <listitem><para>Once satisfied you can build the final package with - &git-buildpackage; <option>--git-tag</option>. This additionally + &gbp-buildpackage; <option>--git-tag</option>. This additionally creates a tag within &git; so you can switch back to that version later at any time. The format of the tags can be specified, tags can be &gpg; signed.</para></listitem> <listitem><para>When a new upstream version is released and upstream - isn't using &git; you can import the new version via &git-import-orig; - onto the <option>upstream-branch</option>. &git-import-orig; will + isn't using &git; you can import the new version via &gbp-import-orig; + onto the <option>upstream-branch</option>. &gbp-import-orig; will by default try to merge the new upstream version onto the <option>debian-branch</option>. You can skip the merge with <option>--no-merge</option>. After resolving any potential conflicts diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml index d5cf0871..6f00995a 100644 --- a/docs/chapters/releases.sgml +++ b/docs/chapters/releases.sgml @@ -3,7 +3,7 @@ <para>When branching and merging frequently, the different Debian changelog entries on the different branches tend to get into the way of the automatic merge and the the merge fails - leaving the (pathological) merge to the - committer. In order to avoid this &git-dch; offers a way for creating + committer. In order to avoid this &gbp-dch; offers a way for creating changelog entries from &git; commits before doing a release or anytime between releases.</para> <para> @@ -12,7 +12,7 @@ <emphasis>debian/changelog</emphasis> at all. Then, when done, do: </para> <screen> -&git-dch; <option>--release</option> +&gbp-dch; <option>--release</option> </screen> <para> This will look up the latest released version in the changelog, increment the version in the &debian; changelog, generate changelog @@ -23,7 +23,7 @@ But what if you want to have an (unreleased) snapshot for intermediate testing: </para> <screen> -&git-dch; <option>--snapshot</option> +&gbp-dch; <option>--snapshot</option> </screen> <para>will generate a snapshot release with a specially crafted version number and a warning in the changelog that this is a snapshort release: @@ -37,22 +37,22 @@ git-buildpackage (0.3.7~1.gbp470ce2) UNRELEASED; urgency=low </programlisting> <para>During subsequent calls with <option>--snapshot</option> this version number will continue to increase. Since the snapshot banners contains the - commit id of the current branch head, &git-dch; can figure out what to + commit id of the current branch head, &gbp-dch; can figure out what to append to the changelog by itself: <screen> -&git-dch; <option>--snapshot</option> <option>--auto</option> +&gbp-dch; <option>--snapshot</option> <option>--auto</option> </screen> will fetch the commit id and add changelog entries from that point to the current HEAD - again auto incrementing the version number. If you don't want to start at that commit id, you can specify any id or tag with:</para> <screen> -&git-dch; <option>--since</option>=<replaceable>e76a6a180a57701ae4ae381f74523cacb3152780</replaceable> <option>--snapshot</option> +&gbp-dch; <option>--since</option>=<replaceable>e76a6a180a57701ae4ae381f74523cacb3152780</replaceable> <option>--snapshot</option> </screen> <para> - After testing you can remove the snapshot header by a final &git-dch; call: + After testing you can remove the snapshot header by a final &gbp-dch; call: </para> <screen> -&git-dch; <option>--since</option>=<replaceable>HEAD</replaceable> <option>--release</option> +&gbp-dch; <option>--since</option>=<replaceable>HEAD</replaceable> <option>--release</option> </screen> <para> This will add no further entries but simply remove the specially crafted @@ -66,10 +66,10 @@ git-buildpackage (0.3.7~1.gbp470ce2) UNRELEASED; urgency=low can give any python expression that evaluates to a positive integer to calculate the new snapshot number:</para> <screen> -&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>1</replaceable> -&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'snapshot + 2'</replaceable> -&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'os.popen("git-log --pretty=oneline | wc -l").readlines()[0]'</replaceable> -&git-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>`git-log --pretty=oneline debian/0.3.3 | wc -l`</replaceable> +&gbp-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>1</replaceable> +&gbp-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'snapshot + 2'</replaceable> +&gbp-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>'os.popen("git-log --pretty=oneline | wc -l").readlines()[0]'</replaceable> +&gbp-dch; <option>-S</option> <option>-a</option> <option>--snapshot-number</option>=<replaceable>`git-log --pretty=oneline debian/0.3.3 | wc -l`</replaceable> </screen> <para> You can also add the snapshot-number calculation to <filename>gbp.conf</filename>: @@ -129,7 +129,7 @@ To only include the short description in the changelog and skip the body use: <screen> Git-Dch: Short </screen> -The latter only takes effect when running &git-dch; with the +The latter only takes effect when running &gbp-dch; with the <option>--full</option> option, since including only the short description is the default. </para> @@ -144,7 +144,7 @@ Cl2vcs</ulink> for how this looks. </para> <para> The inclusion of the commit id can be done automatically -via &git-dch;'s <option>--id-length</option> option. Using +via &gbp-dch;'s <option>--id-length</option> option. Using <option>--id-length</option>=<replaceable>7</replaceable> would change the above example to: <screen> * [571bfd4] New upstream version (Closes: #1000) - thanks to cool upstream diff --git a/docs/chapters/special.sgml b/docs/chapters/special.sgml index 653f0ae2..9c8aa648 100644 --- a/docs/chapters/special.sgml +++ b/docs/chapters/special.sgml @@ -18,7 +18,7 @@ <emphasis>master</emphasis>): </para> <screen> -&git-import-orig; --no-merge <filename>/path/to/nondfsg-clean-package_10.4.orig.tar.gz</filename> +&gbp-import-orig; --no-merge <filename>/path/to/nondfsg-clean-package_10.4.orig.tar.gz</filename> &gitcmd; <option>tag</option> 10.4 </screen> <para> @@ -50,11 +50,11 @@ cleanup-script.sh &gitcmd; <option>branch</option> <replaceable>nmu</replaceable> <replaceable>master</replaceable> </screen> <para> - To import an NMU change into the git repository and use &git-import-dsc;: + To import an NMU change into the git repository and use &gbp-import-dsc;: </para> <screen> &gitcmd; checkout <replaceable>master</replaceable> -&git-import-dsc; <option>--debian-branch</option>=<replaceable>nmu</replaceable> <filename>/path/to/package_1.0-1nmu0.dsc</filename> +&gbp-import-dsc; <option>--debian-branch</option>=<replaceable>nmu</replaceable> <filename>/path/to/package_1.0-1nmu0.dsc</filename> </screen> <para> This will import the NMU onto the branched named <emphasis>nmu</emphasis> @@ -96,7 +96,7 @@ builder = /usr/bin/git-pbuilder <envar>sid</envar> distribution. If you want to build for another distribution pass this in the <envar>DIST</envar> environment variable. - Invoking &git-buildpackage; will now invoke &pdebuildcmd; by + Invoking &gbp-buildpackage; will now invoke &pdebuildcmd; by default and all additional command line arguments are passed to <command>dpkg-buildpackage</command>. If you want to use <command>debuild</command> again (without modifying @@ -106,7 +106,7 @@ builder = /usr/bin/git-pbuilder </programlisting> Furthermore, if you don't want this for all your invocations of - &git-buildpackage; you can use <filename>.git/gbp.conf</filename> in + &gbp-buildpackage; you can use <filename>.git/gbp.conf</filename> in one of your &git; repositories instead of <filename>~/.gbp.conf</filename>. </para> diff --git a/docs/common.ent b/docs/common.ent index a6da38bc..730d4311 100644 --- a/docs/common.ent +++ b/docs/common.ent @@ -4,11 +4,11 @@ <!ENTITY dhconfsection "<manvolnum>5</manvolnum>"> <!ENTITY dhemail "<email>agx@sigxcpu.org</email>"> <!ENTITY dhusername "Guido Guenther"> - <!ENTITY git-buildpackage "<command>gbp buildpackage</command>"> - <!ENTITY git-import-orig "<command>gbp import-orig</command>"> - <!ENTITY git-import-dsc "<command>gbp import-dsc</command>"> - <!ENTITY git-import-dscs "<command>gbp import-dscs</command>"> - <!ENTITY git-dch "<command>gbp dch</command>"> + <!ENTITY gbp-buildpackage "<command>gbp buildpackage</command>"> + <!ENTITY gbp-import-orig "<command>gbp import-orig</command>"> + <!ENTITY gbp-import-dsc "<command>gbp import-dsc</command>"> + <!ENTITY gbp-import-dscs "<command>gbp import-dscs</command>"> + <!ENTITY gbp-dch "<command>gbp dch</command>"> <!ENTITY gbp "<command>gbp</command>"> <!ENTITY gbp-pull "<command>gbp pull</command>"> <!ENTITY gbp-clone "<command>gbp clone</command>"> diff --git a/docs/manpages/gbp.conf.sgml b/docs/manpages/gbp.conf.sgml index b800a961..4ffa116c 100644 --- a/docs/manpages/gbp.conf.sgml +++ b/docs/manpages/gbp.conf.sgml @@ -56,7 +56,7 @@ key = value [<command>] - # Specific sections for each command, like &git-buildpackage; + # Specific sections for each command, like &gbp-buildpackage; key = value [remote-config <name>] diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml index 88e26c02..4660f5f4 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 d1256a6e..7e550f37 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>~<snaspshotnumber>.gbp<commitid></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 3a55123a..221288fc 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 881c1a36..b494e294 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 54c584eb..e8ce68e7 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> |