You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/05/08 00:10:31 UTC

cordova-medic git commit: Adding extra slave docs after some recent problems came up and were resolved.

Repository: cordova-medic
Updated Branches:
  refs/heads/master e75b82259 -> c6e5bd702


Adding extra slave docs after some recent problems came up and were resolved.


Project: http://git-wip-us.apache.org/repos/asf/cordova-medic/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-medic/commit/c6e5bd70
Tree: http://git-wip-us.apache.org/repos/asf/cordova-medic/tree/c6e5bd70
Diff: http://git-wip-us.apache.org/repos/asf/cordova-medic/diff/c6e5bd70

Branch: refs/heads/master
Commit: c6e5bd7020d5df8ac920536ac5814eeecca2f449
Parents: e75b822
Author: Dmitry Blotsky <dm...@gmail.com>
Authored: Tue May 5 17:08:11 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Thu May 7 15:10:01 2015 -0700

----------------------------------------------------------------------
 SLAVES.md | 37 ++++++++++++++++++++++++++++++++-----
 1 file changed, 32 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-medic/blob/c6e5bd70/SLAVES.md
----------------------------------------------------------------------
diff --git a/SLAVES.md b/SLAVES.md
index 9c99985..64f4b70 100644
--- a/SLAVES.md
+++ b/SLAVES.md
@@ -3,11 +3,21 @@ Cordova Medic Slaves
 
 This document describes slave-specific setup for Cordova Medic for running builds on each platform.
 
-## Slave Setup
+## Machine Setup
 
-### All Operating Systems
+### Disk Indexer Thrashing
 
-Since the build process writes and rewrites many files to the file system of the slave machine, the slave directory *should be excluded from the operating system's file system indexing* process to avoid disk thrashing.
+Since the build process writes and rewrites many files to the file system of the slave machine, the slave directory *should be excluded from the operating system's file system indexing process* to avoid disk thrashing. This can be accessed by changing Disk Indexer settings on Windows, or changing Spotlight Privacy settings on OS X.
+
+### Machine Sleep
+
+Disable machine sleep so that the slave is always on.
+
+### Screen Saver
+
+Enabling a screen saver has been observed to interfere with running emulators. Disable screen savers to avoid this problem.
+
+## Environment Setup
 
 ### iOS
 
@@ -19,18 +29,33 @@ Two special NPM packages are also required for Medic builds on iOS: `ios-sim` an
 
 ### Android
 
-For Android slaves, the Android SDK is required, and can be installed with Android Studio as described [here][android_full] or without Android Studio as described [here][android_cli]. Alternatively, if the slave is running Windows, all tools required for Cordova can be installed in bulk using the the VS [tools for Cordova][vs_cordova].
+For Android slaves, the Android SDK is required, and can be installed with Android Studio as described [here][android_full] or without Android Studio as described [here][android_cli]. Alternatively (but only if the slave is running Windows) all tools required for Cordova can be installed in bulk using the the VS [tools for Cordova][vs_cordova].
+
+#### Environment Variables
+
+To make the Android commands available on the command line, set the following environment variables:
 
-Once the SDK is installed, Android tools can be installed by running:
+- `ANDROID_HOME`, equal to the absolute path to the Android SDK directory
+- `PATH`, extended to contain `ANDROID_HOME/tools` and `ANDROID_HOME/platform_tools`
+
+#### SDK
+
+Once the SDK base is installed, actual tools and libraries can be installed by running:
 
     android
 
+Select and install the tools and SDK appropriate for the latest version of Android supported by Cordova. Usually these are the latest set of tools that are automatically selected by running `android`. Alternatively, if you execute `cordova build` without the proper SDK installed, the build process will terminate with a message telling you which version of the Android SDK it needs.
+
 For emulation, at least one Android Virtual Device should be available, which can be created by running:
 
     android avd
 
 **Note:** Due to an [existing issue][issue], configure the AVD such that it has an SD card with space greater than 0KB.
 
+#### Ant
+
+If you're using Ant to build, you will also need it to be installed. The official Ant installation instructions are [here][ant].
+
 ### Windows 8 and Windows 8.1
 
 For Windows slaves, Visual Studio is required. For deployment to devices, a Windows Developer License is also required. To install a license, run the following from PowerShell:
@@ -44,6 +69,7 @@ There is an installation of Buildbot running on Apache Infrastructure, which can
 1. The slave needs to be defined in `master.cfg` in the Apache Infrastructure [SVN repository][infra_svn] (this requires Cordova committer access)
 2. Credentials for connecting to the master need to be obtained via a [JIRA ticket][infra_jira] to the Apache Infrastructure team
 3. The slave needs to be configured to connect to the Apache master, which can done either:
+
     a. By modifying an existing slave's `buildbot.tac` to point to the Apache master and use the given password **OR**
     b. By creating a new slave with a **dummy** password\*, and then editing the slave's `buildbot.tac`
 
@@ -56,3 +82,4 @@ There is an installation of Buildbot running on Apache Infrastructure, which can
 [ci]:           http://ci.cordova.io
 [infra_jira]:   https://www.apache.org/dev/infra-contact
 [infra_svn]:    https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/
+[ant]:          http://ant.apache.org/manual/install.html


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org