[tor-commits] [tor-browser-build/master] Bug 23680: document the types of builds (testbuild/nightly/alpha) in README.HACKING

[gk at torproject.org]

commit 2d5b42b7b8bea03bf55fc3ad2c1ea993e18af191
Author: Nicolas Vigier <boklm at torproject.org>
Date:   Thu Sep 28 12:17:12 2017 +0200

    Bug 23680: document the types of builds (testbuild/nightly/alpha) in README.HACKING
---
 README.HACKING | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.HACKING b/README.HACKING
index e328ea1..d9ebf63 100644
--- a/README.HACKING
+++ b/README.HACKING
@@ -238,6 +238,10 @@ the new commits. If you want to fetch new commits automatically when
 starting a new build you can add a "fetch: 1" line to
 projects/firefox/config.
 
+Remember that the git_hash option has different definitions for alpha
+and nightly builds, so you should modify the right one depending on
+what type of build you are doing (see also the "Types of builds" section).
+
 
 The Firefox mozconfig files
 ---------------------------
@@ -293,3 +297,20 @@ For example, if you want to try a Linux x86_64 alpha build, you can run:
   $ /path_to_rbm/rbm build release --target alpha --target \
                                                 torbrowser-linux-x86_64
 
+
+Types of builds: nightly, alpha, release and testbuild
+------------------------------------------------------
+
+The testbuild makefile target allows you to do a build quickly in the
+testbuild directory, skipping the generation of all the locales and the
+mar files. This is useful during development.
+
+By default the testbuild is based on the alpha build. All the options
+can have a different definition for the alpha, release and nightly builds.
+Usually the git_hash option has a different definition for the nightly
+builds in order to point to the master branch.
+
+If you want your testbuild target to create builds based on nightly
+rather than alpha, you can edit your rbm.local.conf file and uncomment
+the targets/torbrowser-testbuild definition.
+