From b2f61eb5676befc162a55668e1c4f458d1b0aa92 Mon Sep 17 00:00:00 2001 From: Iva Koevska Date: Tue, 1 Sep 2015 13:50:47 +0300 Subject: [PATCH] Note that when --release is specified, you should also set the --keystore options for Android build operations --- docs/man_pages/project/testing/build-android.md | 6 +++++- docs/man_pages/project/testing/deploy.md | 3 ++- docs/man_pages/project/testing/emulate-android.md | 3 ++- docs/man_pages/project/testing/run-android.md | 5 +++-- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/man_pages/project/testing/build-android.md b/docs/man_pages/project/testing/build-android.md index 24c9ec8642..da1d69dcb1 100644 --- a/docs/man_pages/project/testing/build-android.md +++ b/docs/man_pages/project/testing/build-android.md @@ -8,13 +8,17 @@ General | `$ tns build android [--key-store-path --key-store-passwor Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator. ### Options -* `--release` - If set, produces a release build. Otherwise, produces a debug build. When the `--key-store-*` options are specified, produces a signed release build. +* `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options. * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. <% if(isHtml) { %> +### Command Limitations + +* When the `--release` flag is set, you must also specify all `--key-store-*` options. + ### Related Commands Command | Description diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md index 1b2979e7bd..f3e93dd08c 100644 --- a/docs/man_pages/project/testing/deploy.md +++ b/docs/man_pages/project/testing/deploy.md @@ -17,7 +17,7 @@ Builds and deploys the project to a connected physical or virtual device. <% if( ### Options<% if(isMacOS) { %> for Android<% } %> * `--device` - Deploys the project on the specified connected physical or virtual device. -* `--release` - If set, produces a release build. Otherwise, produces a debug build. When the `--key-store-*` options are specified, produces a signed release build. +* `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options. * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. @@ -30,6 +30,7 @@ Builds and deploys the project to a connected physical or virtual device. <% if( ### Command Limitations * You can run `$ tns deploy ios` only on OS X systems. +* When the `--release` flag is set for an Android build, you must also specify all `--key-store-*` options. ### Related Commands diff --git a/docs/man_pages/project/testing/emulate-android.md b/docs/man_pages/project/testing/emulate-android.md index 7ee9fef86b..36ea6a91dc 100644 --- a/docs/man_pages/project/testing/emulate-android.md +++ b/docs/man_pages/project/testing/emulate-android.md @@ -14,7 +14,7 @@ Builds the specified project and runs it in the native emulator from the Android * `--avd` - Sets the Android virtual device on which you want to run your app. You can set only one device at a time. You cannot use `--avd` and `--geny` simultaneously. * `--geny` - Sets the Genymotion virtual device on which you want to run your app. You can set only one device at a time. You cannot use `--avd` and `--geny` simultaneously. * `--timeout` - Sets the number of seconds that the NativeScript CLI will wait for the virtual device to boot before quitting the operation and releasing the console. If not set, the default timeout is 120 seconds. To wait indefinitely, set 0. -* `--release` - If set, produces a release build. Otherwise, produces a debug build. When the `--key-store-*` options are specified, produces a signed release build. +* `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options. * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-password` - Provides the password for the keystore file specified with --key-store-path. You can use the `--key-store-*` options along with --release to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. @@ -42,6 +42,7 @@ Before running your app in the Android emulator from the Android SDK, verify tha ### Command Limitations * You can run this command for one virtual device at a time. To test your app on multiple Android virtual devices, run `$ tns emulate android --avd ` or `$ tns emulate android --geny ` for each virtual device. +* When the `--release` flag is set, you must also specify all `--key-store-*` options. ### Related Commands diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md index dbdf1b300c..dd7818fff9 100644 --- a/docs/man_pages/project/testing/run-android.md +++ b/docs/man_pages/project/testing/run-android.md @@ -12,7 +12,7 @@ Runs your project on a connected Android device or in a native Android emulator, ### Options * `--device` - Specifies a connected device on which to run the app. * `--emulator` - If set, runs the app in a native emulator for the target platform, if configured. When set, you can also set any other valid combination of emulator options as listed by `$ tns help emulate android`. -* `--release` - If set, produces a release build. Otherwise, produces a debug build. When the `--key-store-*` options are specified, produces a signed release build. +* `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options. * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. @@ -24,7 +24,7 @@ Runs your project on a connected Android device or in a native Android emulator, * `` is any valid combination of options as listed by `$ tns help emulate android` <% if(isHtml) { %> -###Prerequisites: +### Prerequisites: Before running your app in the Android emulator from the Android SDK, verify that your system meets the following requirements. * Verify that you have installed the Android SDK. * Verify that you have added the following Android SDK directories to the `PATH` environment variable: @@ -40,6 +40,7 @@ Before running your app in the Android emulator from the Android SDK, verify tha ### Command Limitations * You cannot use `--device` and `--emulator` simultaneously. +* When the `--release` flag is set, you must also specify all `--key-store-*` options. ### Related Commands