From f8e46a09596d7a3bbd85cd986c2002cd5dfcf32b Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Wed, 19 Nov 2014 15:29:07 +0000 Subject: [PATCH] Updates to use new, easier command sequences for Git. --- docs/en/rst/installing/linux.rst | 5 +++-- docs/en/rst/installing/mac-os-x.rst | 7 ++++--- docs/en/rst/installing/quick-start.rst | 13 ++++--------- docs/en/rst/installing/windows.rst | 5 ++++- docs/en/rst/upgrading/migrating-from-2.inc.rst | 8 ++++---- docs/en/rst/upgrading/upgrading-with-git.rst | 16 ++++++++++++---- 6 files changed, 31 insertions(+), 23 deletions(-) diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst index d94977fb73..3f4cb9169e 100644 --- a/docs/en/rst/installing/linux.rst +++ b/docs/en/rst/installing/linux.rst @@ -124,9 +124,10 @@ Bugzilla The best way to get Bugzilla is to check it out from git: -:command:`git clone https://git.mozilla.org/bugzilla/bugzilla` +:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla` -.. todo:: Need to check out stable branch, not master +Run the above command in your home directory, replacing "X.X" with the 2-digit +version number of the stable release of Bugzilla that you want - e.g. "4.4". If that's not possible, you can `download a tarball of Bugzilla `_. diff --git a/docs/en/rst/installing/mac-os-x.rst b/docs/en/rst/installing/mac-os-x.rst index 77730ce6e3..bc04d8a66c 100644 --- a/docs/en/rst/installing/mac-os-x.rst +++ b/docs/en/rst/installing/mac-os-x.rst @@ -23,10 +23,11 @@ Bugzilla The best way to get Bugzilla is to check it out from git: -:command:`git clone https://git.mozilla.org/bugzilla/bugzilla` +:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla` -Run the above command in your home directory. This will place Bugzilla in -the directory :file:`$HOME/bugzilla`. +Run the above command in your home directory, replacing "X.X" with the 2-digit +version number of the stable release of Bugzilla that you want - e.g. "4.4". +This will place Bugzilla in the directory :file:`$HOME/bugzilla`. If that's not possible, you can `download a tarball of Bugzilla `_. diff --git a/docs/en/rst/installing/quick-start.rst b/docs/en/rst/installing/quick-start.rst index 414ebc2c38..5ef758f306 100644 --- a/docs/en/rst/installing/quick-start.rst +++ b/docs/en/rst/installing/quick-start.rst @@ -66,17 +66,12 @@ Get it from our Git repository: :command:`rm -rf html` -:command:`git clone https://git.mozilla.org/bugzilla/bugzilla html` +:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla html` -:command:`cd html` - -:command:`git checkout bugzilla-stable` +(where "X.X" is the 2-digit version number of the stable release of Bugzilla +that you want - e.g. 4.4) -You will get a notification about having a detached HEAD. Don't worry, -your head is still firmly on your shoulders. - -.. todo:: is this the right way to get the current bugzilla-stable code? Or - should we pull directly from a branch? +:command:`cd html` Configure MySQL =============== diff --git a/docs/en/rst/installing/windows.rst b/docs/en/rst/installing/windows.rst index 5b5da335ad..49c2a9ea60 100644 --- a/docs/en/rst/installing/windows.rst +++ b/docs/en/rst/installing/windows.rst @@ -44,7 +44,10 @@ Bugzilla The best way to get Bugzilla is to check it out from git. Download and install git from the `git website `_, and then run: -:command:`git clone https://git.mozilla.org/bugzilla/bugzilla C:\\bugzilla` +:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla C:\\bugzilla` + +where "X.X" is the 2-digit version number of the stable release of Bugzilla +that you want (e.g. 4.4). The rest of this documentation assumes you have installed Bugzilla into :file:`C:\\bugzilla`. Adjust paths appropriately if not. diff --git a/docs/en/rst/upgrading/migrating-from-2.inc.rst b/docs/en/rst/upgrading/migrating-from-2.inc.rst index e49ca34ed2..351850ada7 100644 --- a/docs/en/rst/upgrading/migrating-from-2.inc.rst +++ b/docs/en/rst/upgrading/migrating-from-2.inc.rst @@ -18,11 +18,11 @@ Once git is installed, run these commands to pull a copy of Bugzilla: :command:`cd bugzilla-new` -:command:`git checkout $VERSION` +:command:`git checkout release-$VERSION` -Replace $VERSION with the two-digit version number of your current Bugzilla, e.g. -4.2. These command will automatically switch your checkout to be a copy of -the latest point release of version $VERSION. +Replace $VERSION with the three-digit version number of your current Bugzilla, +e.g. "4.2.2". (If the the final digit would have been a 0, omit it - so use +"4.4" for the first release in the 4.4 series.) Save Any Local Customizations ============================= diff --git a/docs/en/rst/upgrading/upgrading-with-git.rst b/docs/en/rst/upgrading/upgrading-with-git.rst index 523906f444..78b4fb1e08 100644 --- a/docs/en/rst/upgrading/upgrading-with-git.rst +++ b/docs/en/rst/upgrading/upgrading-with-git.rst @@ -43,15 +43,23 @@ Getting The New Bugzilla ======================== In the commands below, ``$BUGZILLA_HOME`` represents the directory -in which Bugzilla is installed. +in which Bugzilla is installed. Assuming you followed the installation +instructions and your Bugzilla is a checkout of a stable branch, +you can get the latest point release of your current version by simply doing: :command:`cd $BUGZILLA_HOME` -:command:`git checkout` - :command:`git pull` -.. todo:: What is the best way to pull latest stable? +If you want to upgrade to a newer release of Bugzilla, then you will +additionally need to do: + +:command:`git checkout bugzilla-X.X-stable` + +where "X.X" is the 2-digit version number of the stable version you want to +upgrade to (e.g. "4.4"). + +.. note:: Do not attempt to downgrade Bugzilla this way - it won't work. If you have local code customizations, git will attempt to merge them. If it fails, then you should implement the plan you came up with when you -- 2.47.2