summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2017-08-06 15:48:42 -0300
committerGuido Günther <agx@sigxcpu.org>2017-08-06 15:49:14 -0300
commit5b3fcd679621993a184b6695b36dc3a9a1c4970f (patch)
treebccd844067e3e67c0e0a873af6906925766dde9a
parentf8c429fba5908f51f9aa0830b438acf5ec14a6f5 (diff)
docs: Spell debian-branch consistently
-rw-r--r--docs/chapters/patches.sgml32
-rw-r--r--docs/chapters/special.sgml4
-rw-r--r--docs/common.ent3
3 files changed, 22 insertions, 17 deletions
diff --git a/docs/chapters/patches.sgml b/docs/chapters/patches.sgml
index 5607dae2..50123e3a 100644
--- a/docs/chapters/patches.sgml
+++ b/docs/chapters/patches.sgml
@@ -8,8 +8,9 @@
3.0 (quilt) format source packages.
</para>
- <para>The basic idea is that patches are imported from you debian
- branch to a patch-queue branch with one patch file
+ <para>
+ The basic idea is that patches are imported from you
+ &debian-branch; to a patch-queue branch with one patch file
in <filename>debian/patches/</filename> becoming one commit on the
the patch-queue branch. The created branch will be named after
the branch you imported from
@@ -48,7 +49,7 @@
The main drawback of this workflow is the lack of history on the
patch-queue branch since it is frequently droppend and
recreated. But there is full history on
- the your debian branch, of course.
+ the your &debian-branch;, of course.
</para>
<sect1 id="gbp.patches.workflow">
@@ -68,7 +69,7 @@
</imageobject>
<caption>
<para>
- The debian branch we start from.
+ The &debian-branch; we start from.
</para>
</caption>
</mediaobject>
@@ -209,13 +210,14 @@
would drop your current patch-queue branch (if existent) and
create a new one by going back in your commit history as far as 10
commits to find a place where your patches still
- apply <footnote><para>This is not necessarily your debian branch
- HEAD since the new upstream version might have changed so that the
- patches no longer apply cleanly there.</para></footnote>. If it
- finds such a commit on your debian branch it will create the
- patch-queue branch from there and switch you to that branch. You
- can now rework your patches to apply to the new upstream version
- by using &gbp-pq-rebase;:
+ apply <footnote><para>This is not necessarily
+ your debian-branch; HEAD since the new upstream
+ version might have changed so that the patches no longer apply
+ cleanly there.</para></footnote>. If it finds such a commit on
+ your &debian-branch; it will create the patch-queue branch from
+ there and switch you to that branch. You can now rework your
+ patches to apply to the new upstream version by using
+ &gbp-pq-rebase;:
</para>
<mediaobject>
@@ -224,7 +226,7 @@
</imageobject>
<caption>
<para>
- The patch-queue branch and debian branch after importing the
+ The patch-queue branch and &debian-branch; after importing the
patches.
</para>
</caption>
@@ -270,7 +272,7 @@
</programlisting>
<para>
- The export will also switch you back to the debian branch.
+ The export will also switch you back to the &debian-branch;.
</para>
<mediaobject>
<imageobject>
@@ -278,7 +280,7 @@
</imageobject>
<caption>
<para>
- The debian branch after exporting the patches and committing the changes.
+ The &debian-branch; after exporting the patches and committing the changes.
</para>
</caption>
</mediaobject>
@@ -320,7 +322,7 @@
&gbp-pq-export; --commit
</programlisting>
<para>
- This will switch you back to your debian branch branch, generate the
+ This will switch you back to your &debian-branch; branch, generate the
patches and commit them right away to this branch.
</para>
diff --git a/docs/chapters/special.sgml b/docs/chapters/special.sgml
index fd79f68e..66eaebad 100644
--- a/docs/chapters/special.sgml
+++ b/docs/chapters/special.sgml
@@ -217,8 +217,8 @@ means.
If you're still getting an error about <emphasis>unexpected
upstream changes</emphasis> make sure you have no uncomitted
changes in you workig copy (changes in
- the <filename>debian/</filename> are o.k.) and no files that are
- ignored by git
+ the <filename>debian/</filename> directory are o.k.) and no
+ files that are ignored by git
via <filename>.gitignore</filename>. A <command>git clean
-dfx</command> can help here.
</para>
diff --git a/docs/common.ent b/docs/common.ent
index b1f25770..7ff2ef94 100644
--- a/docs/common.ent
+++ b/docs/common.ent
@@ -46,6 +46,9 @@
<!ENTITY uscan "<command>uscan</command>">
<!ENTITY quilt "<command>quilt</command>">
+ <!ENTITY debian-branch "<option>debian-branch</option>">
+ <!ENTITY upstream-branch "<option>upstream-branch</option>">
+
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY git "<productname>Git</productname>">
<!ENTITY dch "<productname>dch</productname>">