You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by bh...@apache.org on 2013/07/17 21:07:25 UTC
docs commit: [CB-4031] [BlackBerry10] Fixes for BB10 platform guide
Updated Branches:
refs/heads/master 479e92ec0 -> 847dd84b5
[CB-4031] [BlackBerry10] Fixes for BB10 platform guide
- fixed spacing issues
- updated invalid commands
- removed merge conflict artifacts
- added instructions to add ndk tools to path
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/847dd84b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/847dd84b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/847dd84b
Branch: refs/heads/master
Commit: 847dd84b572e92ee9c62c2444b3360d85656db55
Parents: 479e92e
Author: jkeshavarzi <jk...@blackberry.com>
Authored: Wed Jul 17 14:44:31 2013 -0400
Committer: Bryan Higgins <bh...@blackberry.com>
Committed: Wed Jul 17 15:04:39 2013 -0400
----------------------------------------------------------------------
.../edge/guide/platforms/blackberry10/index.md | 19 +++--
.../edge/guide/platforms/blackberry10/tools.md | 82 ++++----------------
2 files changed, 27 insertions(+), 74 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/847dd84b/docs/en/edge/guide/platforms/blackberry10/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/index.md b/docs/en/edge/guide/platforms/blackberry10/index.md
index 1f3dcdd..9cf0f33 100644
--- a/docs/en/edge/guide/platforms/blackberry10/index.md
+++ b/docs/en/edge/guide/platforms/blackberry10/index.md
@@ -31,6 +31,10 @@ Cordova for BlackBerry has the following software requirements:
- node.js (> 0.9.9) [Download node.js now](http://nodejs.org/)
- BlackBerry 10 Native SDK. [Download the BlackBerry 10 Native SDK now.](http://developer.blackberry.com/native/download/)
+ After installing the native SDK, its tools must be added to your system path. Either manually add the bin directory to your path or run the following scripts:
+ - [Linux/Mac] source [BBNDK directory]/bbndk-env.sh
+ - [Windows] [BBNDK directory]\bbndk-env.bat
+
Setting up your signing keys
----------------------------
@@ -47,9 +51,8 @@ To create a new project, you use the `create` command to set up the folder struc
1. On the command line, navigate to the folder where you extracted Cordova.
2. Run the `create` command using the following syntax:
- ```
- bin/create <path-to-project>
- ```
+
+ bin/create <path-to-project>
This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it.
@@ -62,7 +65,7 @@ A target refers to a BlackBerry device or emulator that you will use to test you
To add a target, on the command line, type the following command:
- <path-to-project>/cordova/target add <name> <ip-address> [-t <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
+ <path-to-project>/cordova/target add <name> <ip-address> [-t | --type <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
where
@@ -76,13 +79,13 @@ where
To remove a target, on the command line, type the following command:
- <path-to-project>/cordova/target remove <name>
+ <path-to-project>/cordova/target remove <name>
###Set a target as the default
To specify a specific target as the default, on the command line, type the following command:
- <path-to-project>/cordova/target default <name>
+ <path-to-project>/cordova/target default <name>
Building your app
-----------------
@@ -98,7 +101,7 @@ To build your app, run the build script. You can build the app in either release
To build your app in release mode, on the command line, type the following command:
- <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+ <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
where
@@ -110,7 +113,7 @@ where
To build your app in release mode, on the command line, type the following command:
- <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
+ <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
where
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/847dd84b/docs/en/edge/guide/platforms/blackberry10/tools.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/tools.md b/docs/en/edge/guide/platforms/blackberry10/tools.md
index 627400c..a605680 100644
--- a/docs/en/edge/guide/platforms/blackberry10/tools.md
+++ b/docs/en/edge/guide/platforms/blackberry10/tools.md
@@ -6,9 +6,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -39,11 +39,7 @@ arguments.
The 'create' command creates a new project:
-<<<<<<< HEAD
bin/create <path-to-project>
-=======
- bin/create <path-to-project>
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
## target
@@ -53,11 +49,7 @@ target, or set a target as the default target.
### Add a target
-<<<<<<< HEAD
- <path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
-=======
- <path-to-project>/cordova/target add <name> <ip-address> <device | simulator> [-p | --password <password>] [--pin <device-pin>]
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
+ <path-to-project>/cordova/target add <name> <ip-address> [-t | --type <device | simulator>] [-p | --password <password>] [--pin <device-pin>]
where
@@ -66,7 +58,7 @@ where
- `<ip-address>` specifies the ip address of the BlackBerry device or
simulator.
-- `-p|--password <password>` specifies the password for the device or
+- `-p | --password <password>` specifies the password for the device or
emulator. This is required only if the device or emulator is
password protected.
@@ -77,19 +69,11 @@ where
### Remove a target
-<<<<<<< HEAD
- <path-to-project>/cordova/target remove <name>
-
-### Set a target as the default
-
- <path-to-project>/cordova/target default <name>
-=======
- <path-to-project>/cordova/target remove <name>
+ <path-to-project>/cordova/target remove <name>
### Set a target as the default
- <path-to-project>/cordova/target default <name>
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
+ <path-to-project>/cordova/target default <name>
## build
@@ -99,26 +83,17 @@ in debug mode (which produces an unsigned .bar file).
### Build your project in release mode
-<<<<<<< HEAD
- <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
+ <path-to-project>/cordova/build release [-k | --keystorepass <password>] [-b | --buildId <number>] [-p | --params <params-JSON-file>]
-where:
-=======
- <path-to-project>/cordova/build release -k|--keystorepass <password> [-b|--buildId <number>] [-p|--params <params-JSON-file>]
where
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
-- `-k|--keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
-- `-b|--buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
-- `-p|--params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
+- `-k | --keystorepass <password>` specifies the password you defined when you configured your computer to sign applications.
+- `-b | --buildId <number>` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional.
+- `-p | --params <params-JSON-file>` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional.
### Build your project in debug mode
-<<<<<<< HEAD
- <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
-=======
- <path-to-project>/cordova/build debug [<target>] [-k|--keystorepass <password>] [-p|--params <params-JSON-file>] [-ll|--loglevel <error|warn|verbose>]
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
+ <path-to-project>/cordova/build debug [<target>] [-k | --keystorepass <password>] [-p | --params <params-JSON-file>] [-ll | --loglevel <error|warn|verbose>]
where
@@ -131,16 +106,16 @@ where
connection or be connected to the same Wi-Fi network as your
computer.
-- `-k|--keystorepass <password>` specifies the password you defined
+- `-k | --keystorepass <password>` specifies the password you defined
when you configured your computer to sign applications. This
password is also used to create your debug token. This argument is
only required if you want the script to create and install the debug
token for you.
-- `-p|--params <params-JSON-file>` specifies a JSON file containing
+- `-p | --params <params-JSON-file>` specifies a JSON file containing
additional parameters to pass to downstream tools.
-- `-ll|--loglevel <level>` specifies the log level. The log level may
+- `-ll | --loglevel <level>` specifies the log level. The log level may
be one of `error`, `warn`, or `verbose`.
If you have previously defined a default target (and previously
@@ -148,24 +123,16 @@ installed a debug token, if that target is a BlackBerry device), you
can run the script with no arguments, and the script will package your
app and deploy it to the default target. For example:
-<<<<<<< HEAD
<path-to-project>/cordova/build debug
-=======
- <path-to-project>/cordova/build debug
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
## run
The `run` command deploys the app on the specified BlackBerry device
or an emulator. Before deploying your app, you must first create a
-target for the device or emulator you want to deploy your app to. The
-deploy script will deploy the most recent build of your app.
+target for the device or emulator you want to deploy your app to using
+the target script. The deploy script will deploy the most recent build of your app.
-<<<<<<< HEAD
<path-to-project>/cordova/run <target>
-=======
- <path-to-project>/cordova/run <target>
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed
where
@@ -180,7 +147,6 @@ The `target` command allows you to add and remove plugins
### Fetch a locally hosted plugin
-<<<<<<< HEAD
<path-to-project>/cordova/plugin fetch <path-to-plugin>
### View a list of installed plugins
@@ -194,19 +160,3 @@ The `target` command allows you to add and remove plugins
### Remove a plugin
<path-to-project>/cordova/plugin rm <name>
-
-=======
- <path-to-project>/cordova/plugin fetch <path-to-plugin>
-
-### View a list of installed plugins
-
- <path-to-project>/cordova/plugin ls
-
-### Add a plugin
-
- <path-to-project>/cordova/plugin add <name>
-
-### Remove a plugin
-
- <path-to-project>/cordova/plugin rm <name>
->>>>>>> cc2825e... [CB-3962] monospace for path/dir/file components, changed from italic; no unformatted barewords allowed