Issue 3116 - Document changed multi-locale build procedure

README.md

 Adblock Browser
 ===============
 
 The Adblock Plus browser, based on Firefox for Android.
 
 Building
 --------
 
 First ensure that all dependencies are up to date by calling:
 
@@ skipping 19 matching lines @@
 ### Automation ###
 
 While the manual process is still documented below, the easiest way to create a
 multi-locale build is to use: https://bitbucket.org/adblockplus/adblockbrowser-build.
 
 ### Preparations ###
 
 1. Create a folder outside of the Adblock Browser repo, e.g `abb-multi`
 2. Change into `abb-multi` and clone mozharness via:
 
-        hg clone http://hg.mozilla.org/build/mozharness -r FENNEC_40_0b8_RELEASE
+        hg clone ssh://hg@bitbucket.org/adblockplus/mozharness -r adblockbrowser

[Felix Dahlke, 2015/09/24 09:20:29]

I think that's actually better than before, to just point to the head of the
adblockbrowser branch in mozharness here. That should always be in sync with the
adblockbrowser branch in the adblockbrowser repo, no need to update this line
anymore. The actual mapping is  in adblockbrowser-build/dependencies anyway.

 
 3. Symlink the adblockbrowser repo into `abb-multi`, e.g.:
 
         ln -s ../adblockbrowser adblockbrowser
 
 4. Copy your `mozconfig` from `adblockbrowser` to `abb-multi`, e.g.:
 
         cp adblockbrowser/mozconfig ./mozconfig
 
 5. Create a copy of the build configuration, e.g.:
@@ skipping 12 matching lines @@
 * **Remove the repository pulling part** from `config`.
   The code to remove looks like this:
 
         "repos": [{
             "repo": "https://hg.mozilla.org/%s" % REPO_PATH,
             "tag": "default",
             "dest": BUILD_DIR,
         }],
 
 * Change `"hg_l10n_tag"` in `config` from `default` to `FENNEC_40_0_RELEASE`
+* [Issue #3047][2] introduced a custom build step named `abb-transform-locales`
+  for manipulating search engine availability and order. This must be inserted
+  into `default_actions` right before `package-multi`
 * You might want to remove the `"backup-objdir"` build step if you do
   not want your objdir to be backed up. Keep in mind that you then need to
   clobber for a single-locale build.
 
 An example configuration could look like this:
 
     import os
     # The name of the directory we'll pull our source into.
     BUILD_DIR = "adblockbrowser"
     # This is everything that comes after https://hg.mozilla.org/
@@ skipping 27 matching lines @@
         "l10n_dir": "l10n",
         "merge_locales": True,
         "mozilla_dir": BUILD_DIR,
         "mozconfig": MOZCONFIG,
         "default_actions": [
             "pull-locale-source",
             "build",
             "package-en-US",
             "restore-objdir",
             "add-locales",
+            "abb-transform-locales",
             "package-multi",
             "summary",
         ],
     }
 
 ### Building ###
 
 For performing the multilocale build, invoke
 
     ./mozharness/scripts/multil10n.py --cfg abb-multi-cfg.py
 
 from inside `abb-multi`. The resulting build is located in
 `BUILD_DIR/OBJ_DIR/dist/`
 
 [1]: https://wiki.mozilla.org/Mobile/Fennec/Android
+[2]: https://issues.adblockplus.org/ticket/3047