From 428e8957efc79f4db8dd62b131242dde89d5a72a Mon Sep 17 00:00:00 2001 From: Guido Günther Date: Thu, 22 Jan 2015 14:21:33 +0100 Subject: Make Debian and Git spelling consistent --- docs/chapters/building.sgml | 8 ++++---- docs/chapters/import.sgml | 32 +++++++++++++++---------------- docs/chapters/intro.sgml | 10 +++++----- docs/chapters/releases.sgml | 4 ++-- docs/chapters/special.sgml | 6 +++--- docs/manpages/gbp-buildpackage.sgml | 10 +++++----- docs/manpages/gbp-create-remote-repo.sgml | 2 +- docs/manpages/gbp-dch.sgml | 4 ++-- docs/manpages/gbp-import-dsc.sgml | 16 ++++++++-------- docs/manpages/gbp-import-orig.sgml | 8 ++++---- docs/manpages/gbp-pq.sgml | 6 +++--- docs/manpages/gbp.sgml | 8 ++++---- 12 files changed, 57 insertions(+), 57 deletions(-) (limited to 'docs') 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 @@ &gbp-buildpackage; - This will again build the debian package and tag the final result after + 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 and options. To save typing these option can be @@ -146,7 +146,7 @@ echo "done." ="gbp-posttag-push" to your .gbp.conf and make sure gbp-push - is somewhere in your $PATH. On Debian + is somewhere in your $PATH. On &debian; systems a more complete example can be found in /usr/share/doc/examples/git-buildpackage/examples/gbp-posttag-push. @@ -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. 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 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 @@ Importing already existing &debian; packages - Importing an already exsting debian package into a git repository is as easy as: + Importing an already exsting &debian; package into a &git; repository is as easy as: &gbp-import-dsc; package_0.1-1.dsc - 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 and the - debian patch on the . In case of a debian + &debian; patch on the . In case of a debian native package only the is being used. You can specify alternative branch names via the and @@ -43,7 +43,7 @@ by version number. Importing a new upstream version - Change into your git repository (which can be empty), make sure it + Change into your &git; repository (which can be empty), make sure it has all local modifications committed and run either of: &gbp-import-orig; /path/to/package_0.2.orig.tar.gz @@ -117,7 +117,7 @@ EOF Upstream sources not on a branch 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.: @@ -126,7 +126,7 @@ EOF The important thing here is that the COMMIT_ID specifies a point on the master branch that carried only 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. There's currently no easy way to create the @@ -160,7 +160,7 @@ EOF - Starting a Debian package from scratch + Starting a &debian; package from scratch 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 git init Then you import the upstream sources, branch off the - branch and add the debian files (e.g. via dh_make): + branch and add the &debian; files (e.g. via dh_make): &gbp-import-orig; 0.1 ../package-0.1.tar.gz dh_make @@ -181,7 +181,7 @@ EOF - When upstream uses GIT + When upstream uses Git 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 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. 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. @@ -223,7 +223,7 @@ upstream-tag = v%(version)s to &gbp.conf; to save lots of typing. - First we clone the upstream repository. To avoid any dis ambiguities between the Debian packaging repository + 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 ustream instead of the default origin. @@ -231,9 +231,9 @@ upstream-tag = v%(version)s cd libgbp git checkout -b debian/sid v1.0 - The above makes sure we have debian/sid for the Debian packaging. We didn't create + The above makes sure we have debian/sid for the &debian; packaging. We didn't create any upstream/* 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: 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 Upstream tarballs - If you want to track upstream's git but continue to import the upstream tarballs, + 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 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 Branch layout - By default &gbp; uses one branch to keep the Debian packaging called master + By default &gbp; uses one branch to keep the &debian; packaging called master and a branch to keep the upstream packaging called upstream. @@ -294,7 +294,7 @@ upstream-tag = v%(version)s - the Debian packaging for a release jessie, + the &debian; packaging for a release jessie, wheezy, sid or experimental. 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 @@ Repository Layout and Terminology - It is recommended to have the Debian packaging on a seprate + It is recommended to have the &debian; packaging on a seprate branch than the upstream source this, of course, has - no meaning for Debian native packages. + no meaning for &debian; native packages. 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 @@ . If the is called master the corresponding patch-queue branch is called patch-queue/master. The patch-queue branch is - the debian branch plus the contents of + the &debian; branch plus the contents of debian/patches applied. These branches are managed with &gbp-pq;. @@ -97,14 +97,14 @@ A typical, simple workflow consists of the following steps: - Import a new Debian package via &gbp-import-dsc;. This + Import a new &debian; package via &gbp-import-dsc;. This imports the &debian; Package on the and the upstream sources on the . 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. - Optionally you can create the Debian changelog entries + Optionally you can create the &debian; changelog entries using &gbp-dch; and create snapshot releases for testing using its option. 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 @@ Releases and Snapshots - When branching and merging frequently, the different Debian changelog + 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 and fields in debian/control. See Cl2vcs 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 Working on random packages - 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: git-import-dsc --download package @@ -126,7 +126,7 @@ git-branch debian This uses apt-get to download the source package, puts the orig tarball on the and the - Debian changes on the (by default + &debian; changes on the (by default master). The second command creates a branch called debian. Now you can easily modify the package, revert changes you made, create other branches for @@ -137,7 +137,7 @@ git-diff debian -- - 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: diff --git a/docs/manpages/gbp-buildpackage.sgml b/docs/manpages/gbp-buildpackage.sgml index 0e5561e..8048b1e 100644 --- a/docs/manpages/gbp-buildpackage.sgml +++ b/docs/manpages/gbp-buildpackage.sgml @@ -14,7 +14,7 @@ git-buildpackage gbp-buildpackage - Build Debian packages from a Git repository + Build &debian; packages from a &git; repository @@ -66,7 +66,7 @@ DESCRIPTION - &gbp-buildpackage; is used to build Debian source and .deb packages from + &gbp-buildpackage; is used to build &debian; source and .deb packages from a &git; repository. @@ -416,7 +416,7 @@ - use this tag format when tagging Debian versions, default is + use this tag format when tagging &debian; versions, default is debian/%(version)s @@ -435,7 +435,7 @@ tag-msg-format - use this tag message format when signing Debian versions, + use this tag message format when signing &debian; versions, default is %(pkg)s Debian release %(version)s @@ -607,7 +607,7 @@ EXAMPLES - Build a Debian package using &git-pbuilder; which in turn invokes + Build a &debian; package using &git-pbuilder; which in turn invokes &cowbuildercmd;. Instruct cowbuilder to build within a Wheezy chroot for i386. diff --git a/docs/manpages/gbp-create-remote-repo.sgml b/docs/manpages/gbp-create-remote-repo.sgml index e8f6a09..ea22d83 100644 --- a/docs/manpages/gbp-create-remote-repo.sgml +++ b/docs/manpages/gbp-create-remote-repo.sgml @@ -93,7 +93,7 @@ =branch_name - The branch in the Git repository the Debian package is being + The branch in the &git; repository the &debian; package is being developed on, default is master. diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml index 8ffdc4f..22ab568 100644 --- a/docs/manpages/gbp-dch.sgml +++ b/docs/manpages/gbp-dch.sgml @@ -15,7 +15,7 @@ git-dch; gbp-dch; - Generate the Debian changelog from git commit messages + Generate the &debian; changelog from git commit messages @@ -62,7 +62,7 @@ DESCRIPTION - &gbp-dch; reads git commit messages and generates the Debian changelog from + &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 diff --git a/docs/manpages/gbp-import-dsc.sgml b/docs/manpages/gbp-import-dsc.sgml index e635a3d..965cc87 100644 --- a/docs/manpages/gbp-import-dsc.sgml +++ b/docs/manpages/gbp-import-dsc.sgml @@ -15,7 +15,7 @@ git-import-dsc gbp-import-dsc - Import Debian packages into a Git repository + Import &debian; packages into a &git; repository @@ -51,9 +51,9 @@ DESCRIPTION - &gbp-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 + information, including package name, version, &debian; diffs, and upstream source is automatically detected from the source package. @@ -105,7 +105,7 @@ - use this tag format when tagging Debian versions, + use this tag format when tagging &debian; versions, default is debian/%(version)s @@ -125,7 +125,7 @@ - Don't create Debian tag after importing the Debian patch. This can be + Don't create &debian; tag after importing the &debian; patch. This can be useful if you already created a package but want to further work on it after importing it into git. @@ -185,7 +185,7 @@ - When importing the Debian patch, use the author identity as + When importing the &debian; patch, use the author identity as committer identity. @@ -195,11 +195,11 @@ - When importing the Debian patch, use the author date as + When importing the &debian; patch, use the author date as committer date. - Git will subtly misbehave if the committer date of a commit is not + &git; will subtly misbehave if the committer date of a commit is not later than or equal to all its parents. diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml index d6fb269..6b0993f 100644 --- a/docs/manpages/gbp-import-orig.sgml +++ b/docs/manpages/gbp-import-orig.sgml @@ -80,7 +80,7 @@ - Merge the upstream branch to the debian branch after import + Merge the upstream branch to the &debian; branch after import @@ -89,7 +89,7 @@ - The branch in the Git repository the upstream sources are put + The branch in the &git; repository the upstream sources are put onto. Default is upstream. @@ -99,7 +99,7 @@ - The branch in the Git repository the Debian package is being + The branch in the &git; repository the &debian; package is being developed on, default is master. After importing the new sources on the upstream branch, &gbp-import-orig; will try to merge the new version onto this branch. @@ -189,7 +189,7 @@ Whether to create and keep a symlink from the upstream tarball - to a Debian policy conformant upstream tarball name located in + to a &debian; policy conformant upstream tarball name located in ../. diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml index f1afb04..ae1c09f 100644 --- a/docs/manpages/gbp-pq.sgml +++ b/docs/manpages/gbp-pq.sgml @@ -37,11 +37,11 @@ DESCRIPTION - &gbp-pq; helps one to manage quilt patches in Debian packages that are + &gbp-pq; helps one to manage quilt patches in &debian; packages that are maintained with &gbp;. This is especially useful with packages using the 3.0 (quilt) source format. With &gbp-pq; you can maintain the quilt patches that should be applied to a package on a separate branch called patch-queue - branch. So if your Debian package lives on + branch. So if your &debian; package lives on master the associated patch-queue branch will be called patch-queue/master. @@ -105,7 +105,7 @@ git-am. Use if you want the patch to appear in a separate subdir when exporting the patch queue using . This can be used to separate upstream - pathes from debian specific patches. + pathes from &debian; specific patches. diff --git a/docs/manpages/gbp.sgml b/docs/manpages/gbp.sgml index c0fdddc..4ba7569 100644 --- a/docs/manpages/gbp.sgml +++ b/docs/manpages/gbp.sgml @@ -14,7 +14,7 @@ &gbp; - Maintain Debian packages in Git + Maintain &debian; packages in &git; @@ -30,7 +30,7 @@ DESCRIPTION - &gbp; is used to maintain Debian source packages in the &git; version control system. + &gbp; is used to maintain &debian; source packages in the &git; version control system. @@ -88,7 +88,7 @@ import-dsc - Import a Debian source package into a &git; repository + Import a &debian; source package into a &git; repository @@ -97,7 +97,7 @@ import-dscs - Import several Debian source packages into a &git; repository, sorted + Import several &debian; source packages into a &git; repository, sorted by version number -- cgit v1.2.3