summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOwen W. Taylor <otaylor@fishsoup.net>2008-11-22 14:04:57 -0500
committerOwen W. Taylor <otaylor@fishsoup.net>2008-11-22 14:04:57 -0500
commit93362dc8c5068a568744ef10abaea84715bc4e1a (patch)
tree6f6deaff13df9def93eae9a749f5a29b07b15c28
parentcc442c4f0e10cf503918319a005855f3f06a1bf0 (diff)
Improve documentation of aliases and configuration
Switch the example alias from the 'bgo' to the less obscure 'gnome'. (Suggestion from Ray Strode.) Other minor tweaks to the docs.
-rwxr-xr-xgit-bz19
1 files changed, 10 insertions, 9 deletions
diff --git a/git-bz b/git-bz
index cea4984..c67e40a 100755
--- a/git-bz
+++ b/git-bz
@@ -117,26 +117,27 @@
# =======
# You can create short aliases for different bug trackers as follows
#
-# git config --global bz-tracker.bgo.host bugzilla.gnome.org
+# git config --global bz-tracker.gnome.host bugzilla.gnome.org
#
# And you can set the default bug tracker with:
#
-# git config --global bz.default-tracker bgo
+# git config --global bz.default-tracker gnome
#
-# Per-repository configuration
+# Per-Repository configuration
# ============================
# Setting the default tracker, product and component in the local
-# config for a repository can be useful:
+# config for a repository can be useful. Assuming that a global
+# 'gnome' alias has been set up as above:
#
-# git config bz.default-tracker bugzilla.gnome.org
-# git config bz-tracker.bugzilla.gnome.org.default-product gnome-shell
-# git config bz-tracker.bugzilla.gnome.org.default-component general
+# git config bz.default-tracker gnome
+# git config bz-tracker.gnome.default-product gnome-shell
+# git config bz-tracker.gnome.default-component general
#
# (The default-product and default-component values must always be
# specified within the config for a particular tracker.) Note the
# absence of the --global options.
#
-# Per Tracker Configuration
+# Per-Tracker Configuration
# =========================
# git-bz needs some configuration specific to the bugzilla instance (tracker),
# in particular it needs to know initial field values to use when submitting
@@ -150,7 +151,7 @@
#
# 1) git configuration variables specified for the alias.
#
-# git config --global bz-tracker.bgo.default-bug-severity trivial
+# git config --global bz-tracker.gnome.default-bug-severity trivial
#
# 2) git configuration variables specified for the host
#