diff options
Diffstat (limited to 'docs/chapters')
-rw-r--r-- | docs/chapters/building.sgml | 8 | ||||
-rw-r--r-- | docs/chapters/import.sgml | 32 | ||||
-rw-r--r-- | docs/chapters/intro.sgml | 10 | ||||
-rw-r--r-- | docs/chapters/releases.sgml | 4 | ||||
-rw-r--r-- | docs/chapters/special.sgml | 6 |
5 files changed, 30 insertions, 30 deletions
diff --git a/docs/chapters/building.sgml b/docs/chapters/building.sgml index 495b585..3b32fbb 100644 --- a/docs/chapters/building.sgml +++ b/docs/chapters/building.sgml @@ -28,7 +28,7 @@ <screen> &gbp-buildpackage; <option>--git-tag</option> </screen> - <para>This will again build the debian package and tag the final result after + <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 tags you can use the <option>--git-sign</option> and <option>--git-keyid</option> options. To save typing these option can be @@ -146,7 +146,7 @@ echo "done." <option>posttag</option>=<replaceable>"gbp-posttag-push"</replaceable> </programlisting> to your <filename>.gbp.conf</filename> and make sure <filename>gbp-push</filename> - is somewhere in your <envar>$PATH</envar>. On Debian + is somewhere in your <envar>$PATH</envar>. On &debian; systems a more complete example can be found in <filename>/usr/share/doc/examples/git-buildpackage/examples/gbp-posttag-push</filename>. </para> @@ -159,7 +159,7 @@ echo "done." for the postexport action is to allow further adjustment of the sources prior to building the package. A typical use case scenario is to allow creating multiple source and binary - packages from one Debian branch - e.g. the bootstrap gcc and + packages from one &debian; branch - e.g. the bootstrap gcc and in the next stage the full gcc. </para> <para> The postexport action, postpones the creation of the @@ -179,7 +179,7 @@ echo "done." export-dir = ../build-area # disable the since the sources are being exported first cleaner = -# post export script that handles expansion of Debian specific files +# post export script that handles expansion of &debian; specific files postexport = crosstoolchain-expand.sh </programlisting> diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml index 446b121..4e72975 100644 --- a/docs/chapters/import.sgml +++ b/docs/chapters/import.sgml @@ -3,13 +3,13 @@ <sect1 id="gbp.import.existing"> <title>Importing already existing &debian; packages</title> - <para>Importing an already exsting debian package into a git repository is as easy as: + <para>Importing an already exsting &debian; package into a &git; repository is as easy as: <screen> &gbp-import-dsc; package_0.1-1.dsc </screen> - This will create a new git repository named after the imported package, put + This will create a new &git; repository named after the imported package, put the upstream sources onto the <option>upstream-branch</option> and the - debian patch on the <option>debian-branch</option>. In case of a debian + &debian; patch on the <option>debian-branch</option>. In case of a debian native package only the <option>debian-branch</option> is being used. You can specify alternative branch names via the <option>--upstream-branch</option> and <option>--debian-branch</option> @@ -43,7 +43,7 @@ by version number. <sect1 id="gbp.import.new.upstream"> <title>Importing a new upstream version</title> - <para>Change into your git repository (which can be empty), make sure it + <para>Change into your &git; repository (which can be empty), make sure it has all local modifications committed and run either of: <screen> &gbp-import-orig; <filename>/path/to/package_0.2.orig.tar.gz</filename> @@ -117,7 +117,7 @@ EOF <title>Upstream sources not on a branch</title> <para> If you don't have an upstream branch but started your repository with only - the upstream sources (not the debian patch) you can simply branch from that + the upstream sources (not the &debian; patch) you can simply branch from that point. So use &gitkcmd; or &gitcmd;-log to locate the commit-id of that commit and create the upstream branch from there, e.g.: <screen> @@ -126,7 +126,7 @@ EOF </screen> The important thing here is that the <envar>COMMIT_ID</envar> specifies a point on the master branch that carried <emphasis>only</emphasis> the - upstream sources and not the debian modifications. The above example + upstream sources and not the &debian; modifications. The above example assumes that this was the first commit to that repository. </para> <warning><para>There's currently no <emphasis>easy</emphasis> way to create the @@ -160,7 +160,7 @@ EOF </sect1> <sect1 id="gbp.import.fromscratch"> - <title>Starting a Debian package from scratch</title> + <title>Starting a &debian; package from scratch</title> <para> So far we assumed you already have a &debian; package to start with but what if you want to start a new package? First create an empty repository: @@ -171,7 +171,7 @@ EOF <command>git init</command> </screen> <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): + <option>upstream-branch</option> branch and add the &debian; files (e.g. via dh_make): <screen> &gbp-import-orig; <option>-u</option> <replaceable>0.1</replaceable> <filename>../package-0.1.tar.gz</filename> <command>dh_make</command> @@ -181,7 +181,7 @@ EOF </sect1> <sect1 id="gbp.import.upstream-git"> - <title>When upstream uses GIT</title> + <title>When upstream uses Git</title> <para> If upstream already uses git for packaging there are several ways to handle packaging. Two of them will be described in a bit detail here: @@ -213,7 +213,7 @@ upstream-tag = v%(version)s </para> <para>If you're using &pristine-tar; you can make &gbp-buildpackage commit the generated tarball back to the pristine-tar branch by using the <option>--git-pristine-tar-commit</option> option. This will make sure - others building your package can regenerate the tarball you generated for building the Debian pacakge. + others building your package can regenerate the tarball you generated for building the &debian; package. </para> <sect3> @@ -223,7 +223,7 @@ upstream-tag = v%(version)s to &gbp.conf; to save lots of typing. </para> - <para>First we clone the upstream repository. To avoid any dis ambiguities between the Debian packaging repository + <para>First we clone the upstream repository. To avoid any dis ambiguities between the &debian; packaging repository and the upstream repository we name the upstream repository <replaceable>ustream</replaceable> instead of the default <replaceable>origin</replaceable>. <screen> @@ -231,9 +231,9 @@ upstream-tag = v%(version)s cd libgbp git checkout -b debian/sid v1.0 </screen> - The above makes sure we have <replaceable>debian/sid</replaceable> for the Debian packaging. We didn't create + The above makes sure we have <replaceable>debian/sid</replaceable> for the &debian; packaging. We didn't create any <replaceable>upstream/*</replaceable> branches, they're not needed for the packaging and only need to be - kept up to date. After adding the Debian packaging we build the package. This assumes you're using &pristine-tar; + kept up to date. After adding the &debian; packaging we build the package. This assumes you're using &pristine-tar; and upstream uses a version number format as described above: <screen> gbp buildpackage --git-pristine-tar --git-pristine-tar-commit --git-upstream-tag='v%(version)s' --git-debian-branch=debian/sid @@ -262,7 +262,7 @@ upstream-tag = v%(version)s <sect2 id="gbp.import.upstream.git.tarball"> <title>Upstream tarballs</title> - <para>If you want to track upstream's git but continue to import the upstream tarballs, + <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 &gbp-import-orig;. Assuming you have the upstream source in your @@ -279,7 +279,7 @@ upstream-tag = v%(version)s <sect1 id="gbp.branch.naming"> <title>Branch layout</title> <para> - By default &gbp; uses one branch to keep the Debian packaging called <emphasis>master</emphasis> + By default &gbp; uses one branch to keep the &debian; packaging called <emphasis>master</emphasis> and a branch to keep the upstream packaging called <emphasis>upstream</emphasis>. </para> <para> @@ -294,7 +294,7 @@ upstream-tag = v%(version)s </term> <listitem> <para> - the Debian packaging for a release <emphasis>jessie</emphasis>, + the &debian; packaging for a release <emphasis>jessie</emphasis>, <emphasis>wheezy</emphasis>, <emphasis>sid</emphasis> or <emphasis>experimental</emphasis>. </para> </listitem> diff --git a/docs/chapters/intro.sgml b/docs/chapters/intro.sgml index c29d713..990ca95 100644 --- a/docs/chapters/intro.sgml +++ b/docs/chapters/intro.sgml @@ -28,9 +28,9 @@ <sect1 id="gbp.repository"> <title>Repository Layout and Terminology</title> - <para>It is recommended to have the Debian packaging on a seprate + <para>It is recommended to have the &debian; packaging on a seprate branch than the upstream source <footnote><para>this, of course, has - no meaning for Debian native packages</para></footnote>. + no meaning for &debian; native packages</para></footnote>. This is necessary to be able to import and merge in new upstream versions via &gbp-import-orig;. To distinguish these two branches the following terminology @@ -62,7 +62,7 @@ <option>debian-branch</option>. If the <option>debian-branch</option> is called <emphasis>master</emphasis> the corresponding patch-queue branch is called <emphasis>patch-queue/master</emphasis>. The patch-queue branch is - the debian branch plus the contents of + the &debian; branch plus the contents of <emphasis>debian/patches</emphasis> applied. These branches are managed with &gbp-pq;. </para></listitem> @@ -97,14 +97,14 @@ A typical, simple workflow consists of the following steps: </para> <orderedlist> - <listitem><para>Import a new Debian package via &gbp-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 &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 + <listitem><para>Optionally you can create the &debian; changelog entries 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 diff --git a/docs/chapters/releases.sgml b/docs/chapters/releases.sgml index 6f00995..abc08fd 100644 --- a/docs/chapters/releases.sgml +++ b/docs/chapters/releases.sgml @@ -1,6 +1,6 @@ <chapter id="gbp.releases"> <title>Releases and Snapshots</title> - <para>When branching and merging frequently, the different Debian changelog + <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 &gbp-dch; offers a way for creating @@ -137,7 +137,7 @@ description is the default. Usually changelog entries should correspond to a single &git; commit. In this case it's convenient to include the commit id in the changelog entry. This has the advantage that it's easy for people to identify changes without -having to write very extensive changelog messages - the link back to Git can be +having to write very extensive changelog messages - the link back to &git; can be automated via the <option>Vcs-Browser</option> and <option>Vcs-Git</option> fields in <filename>debian/control</filename>. See <ulink url="https://honk.sigxcpu.org/cl2vcs"> Cl2vcs</ulink> for how this looks. diff --git a/docs/chapters/special.sgml b/docs/chapters/special.sgml index 9c8aa64..7776330 100644 --- a/docs/chapters/special.sgml +++ b/docs/chapters/special.sgml @@ -115,7 +115,7 @@ builder = /usr/bin/git-pbuilder <sect1 id="gbp.special.hacking"> <title>Working on random packages</title> <para> - Whenever you need to work on an arbitrary Debian package you can check it + Whenever you need to work on an arbitrary &debian; package you can check it right into &git; with one command: <programlisting> git-import-dsc --download <filename>package</filename> @@ -126,7 +126,7 @@ git-branch debian <para> This uses <command>apt-get</command> to download the source package, puts the orig tarball on the <option>upstream-branch</option> and the - Debian changes on the <option>debian-branch</option> (by default + &debian; changes on the <option>debian-branch</option> (by default <emphasis>master</emphasis>). The second command creates a branch called <emphasis>debian</emphasis>. Now you can easily modify the package, revert changes you made, create other branches for @@ -137,7 +137,7 @@ git-diff debian -- </programlisting> <para> - to get a nice patch that can be submitted to the Debian BTS. You can also + to get a nice patch that can be submitted to the &debian; BTS. You can also fetch the source package from an URL: <programlisting> |