Noissue - Prepare translations

README.md

Index: README.md
diff --git a/README.md b/README.md
index 97d156ea41666f4cfd5162b9d6777f4e3990fa39..bc6eaa8d976add0650df93d92660583fac429f25 100644
--- a/README.md
+++ b/README.md
@@ -25,4 +25,104 @@ to disable the CrashReporter.
 (Follow-up issue: https://issues.adblockplus.org/ticket/2490)
 
 
+Creating a multilocale build
+----------------------------
+
+###Preparations

[Felix Dahlke, 2015/06/22 08:10:51]

Nit: Space after ### as on http://daringfireball.net/projects/markdown/syntax ?

[René Jeschke, 2015/06/22 10:24:48]

Done.

+
+1. Create a folder outside of the Adblock Browser repo, I call

[Felix Dahlke, 2015/06/22 08:10:51]

Nit: s/I call it/e.g./

[René Jeschke, 2015/06/22 10:24:48]

Done.

+   it `abb-multi`
+2. Change into `abb-multi` and clone mozharness via:
+    
+        hg clone http://hg.mozilla.org/build/mozharness

[Felix Dahlke, 2015/06/22 08:10:51]

I presume this is always tied to the most recent Firefox version? Can we offer a
clone of that to ensure it's the right version? Maybe something for a follow-up
issue.

[René Jeschke, 2015/06/22 10:24:47]

We can clone everything, so, yes, we can file a follow up issue for this.

+
+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.:

[Felix Dahlke, 2015/06/22 08:10:51]

Nit: adblockbrowser also in backticks?

[René Jeschke, 2015/06/22 10:24:47]

Done.

+
+        cp adblockbrowser/mozconfig ./mozconfig

[Felix Dahlke, 2015/06/22 08:10:51]

Even though we call it `mozconfig`, the file is actually called `.mozconfig`. Is
`mozconfig` even being loaded?

[René Jeschke, 2015/06/22 10:24:48]

We do not call this 'mozconfig', Mozilla calls this 'mozconfig'. I told you
about this twice already, but here we go again:

Again: in this README we say: "follow Mozilla's build instructions for Fennec"
... and in their step-by-step guide, this file is called 'mozconfig' (it's
called so by Mozilla), without a dot. Yes, it works.

Here's the quote from Mozilla:

"Next, navigate to your source directory and create a text file called
"mozconfig". The mozconfig file is what tells the Mozilla build system what to
build and how your build environment is prepared. Here is the minimal mozconfig
file for building Fennec; it should be named mozconfig in your source directory,
as the build scripts will read from the mozconfig file in your source directory
by default"

(quoted from
https://wiki.mozilla.org/Mobile/Fennec/Android#Preparing_your_build_environment
)

The file is called 'mozconfig' everywhere in their build guide, so we should
stick to 'mozconfig'.

[Felix Dahlke, 2015/06/22 12:01:01]

They're actually a bit inconsistent here, but I thought they generally refer to
`.mozconfig` when talking about the file on disk, apparently it's pretty messed
up.

My point, however, is that `.mozconfig` is a file that's being automatically
loaded whereas `mozconfig` or any other variation of the name needs to be
explicitly picked.

[René Jeschke, 2015/06/22 12:09:15]

Still, I am using 'mozconfig' (from the start), it gets automatically loaded and
it's even referenced like this in the mozharness repository. Yes, maybe they
call it differently for the desktop builds, but at least for Fennec it is called
"mozconfig" without the dot, so I think we should stick with this naming, as
this reduces confusion. Or do you have really strong objections against this?

[Felix Dahlke, 2015/06/22 18:18:27]

`mozconfig` gets automatically used by the build system for you? That's exactly
what I mean - for me it doesn't. I have to set the MOZCONFIG variable to use any
other file name.

No, I don't have strong objections, just wanted to point out that it doesn't
make sense to me :D

+
+5. Create a copy of the build configuration, by:
+
+        cp mozharness/configs/multi_locale/standalone_mozilla-central.py abb-multi-cfg.py

[Felix Dahlke, 2015/06/22 08:10:52]

mozilla-central? Isn't there something for mozilla-release, which we are on? (If
we keep up with upstream that is, if we fall behind we're on something that
probably doesn't exist in mozharness.)

[René Jeschke, 2015/06/22 10:24:48]

There is only one .py config gile in this folder, but we can change the L10N
repo base path to one of the release L10N bases on hg.mozilla.org.

+
+###Configuration
+
+* Change `BUILD_DIR = "mozilla-central"` to `BUILD_DIR = "adblockbrowser"` in
+  `L3`

[Felix Dahlke, 2015/06/22 08:10:51]

Was wondering for a while what "L3" for a while, but once I got that it's the
line number: I don't think it's a good idea to hard code line numbers here,
those seem incredibly likely to change. "Look for X and change it to Y" is
generally better for instructions IMHO.

[René Jeschke, 2015/06/22 10:24:48]

Done.

+* Make sure `OBJDIR = "objdir-droid"` in `L12` matches your build output
+  folder
+* If your `mozconfig` is not called `mozconfig`, change `MOZCONFIG` in `L17`
+* **Remove the repository pulling part** from the config, i.e. `L26` to `L30`.

[Felix Dahlke, 2015/06/22 08:10:52]

After reading this far, I Think what we should actually do is:

1. Fork mozconfig
2. Make all these changes in our fork (in a branch/bookmark named
"adblockbrowser")
3. Adjust the repository pulling part to fetch the "adblockbrowser" branch.

[René Jeschke, 2015/06/22 10:24:48]

Why do you want to fork a local build configuration file (i.e. mozconfig)? Also,
we should refrain from hard-coding build configurations inside a repository
anyway.

[Felix Dahlke, 2015/06/22 12:01:01]

Sorry, I meant mozharness. We're setting up a new script there, we should do
that in our own fork of mozharness IMO.

[René Jeschke, 2015/06/22 12:09:14]

Yes, maybe we should do this, needs another follow up issue :-)

[Felix Dahlke, 2015/06/22 18:18:27]

Seems like something we should figure out now to me - apparently the mozharness
you're using wants to work against mozilla-central. How does Mozilla use it in
release builds?

+  The code to remove looks like this:
+
+        26     "repos": [{
+        27         "repo": "https://hg.mozilla.org/%s" % REPO_PATH,
+        28         "tag": "default",
+        29         "dest": BUILD_DIR,
+        30     }],
+* You might want to remove the `"backup-objdir"` build step in `L45` if you do
+  not want your objdir to be backupped. Keep in mind that you then need to
+  clobber for a single-locale build.
+
+An example configuration could look like this:
+
+     1 import os
+     2 # The name of the directory we'll pull our source into.
+     3 BUILD_DIR = "adblockbrowser"
+     4 # This is everything that comes after https://hg.mozilla.org/
+     5 # e.g. "releases/mozilla-aurora"
+     6 REPO_PATH = "mozilla-central"
+     7 # This is where the l10n repos are (everything after https://hg.mozilla.org/)
+     8 # for mozilla-central, that's "l10n-central".
+     9 # For mozilla-aurora, that's "releases/l10n/mozilla-aurora"
+    10 L10N_REPO_PATH = "l10n-central"
+    11 # Currently this is assumed to be a subdirectory of your build dir
+    12 OBJDIR = "obj-android"
+    13 # Set this to mobile/xul for XUL Fennec
+    14 ANDROID_DIR = "mobile/android"
+    15 # Absolute path to your mozconfig.
+    16 # By default it looks at "./mozconfig"
+    17 MOZCONFIG = os.path.join(os.getcwd(), "mozconfig")
+    18 
+    19 config = {
+    20     "work_dir": ".",
+    21     "log_name": "multilocale",
+    22     "objdir": OBJDIR,
+    23     "locales_file": "%s/%s/locales/maemo-locales" % (BUILD_DIR, ANDROID_DIR),
+    24     "locales_dir": "%s/locales" % ANDROID_DIR,
+    25     "ignore_locales": ["en-US", "multi"],
+    26     "l10n_repos": [{
+    27         "repo": "https://hg.mozilla.org/build/compare-locales",
+    28         "tag": "RELEASE_AUTOMATION"
+    29     }],
+    30     "hg_l10n_base": "https://hg.mozilla.org/%s" % L10N_REPO_PATH,
+    31     "hg_l10n_tag": "default",
+    32     "l10n_dir": "l10n",
+    33     "merge_locales": True,
+    34     "mozilla_dir": BUILD_DIR,
+    35     "mozconfig": MOZCONFIG,
+    36     "default_actions": [
+    37         "pull-locale-source",
+    38         "build",
+    39         "package-en-US",
+    40         "restore-objdir",
+    41         "add-locales",
+    42         "package-multi",
+    43         "summary",
+    44     ],
+    45 }
+
+###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