cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marc...@apache.org
Subject docs commit: CB-5648: Clarify parms to "cordova create"
Date Mon, 23 Dec 2013 16:06:18 GMT
Updated Branches:
  refs/heads/master 97ae96eef -> e9e0857cd


CB-5648: Clarify parms to "cordova create"

Especially for the optional parameters.
And mention the default values


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

Branch: refs/heads/master
Commit: e9e0857cd9552ffb49729b396fa0ee4e1b72643c
Parents: 97ae96e
Author: Marcel Kinard <cmarcelk@gmail.com>
Authored: Wed Dec 18 15:26:00 2013 -0500
Committer: Marcel Kinard <cmarcelk@gmail.com>
Committed: Mon Dec 23 11:04:00 2013 -0500

----------------------------------------------------------------------
 docs/en/edge/guide/cli/index.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e9e0857c/docs/en/edge/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cli/index.md b/docs/en/edge/guide/cli/index.md
index 7cf5bfc..c64a878 100644
--- a/docs/en/edge/guide/cli/index.md
+++ b/docs/en/edge/guide/cli/index.md
@@ -87,17 +87,28 @@ command such as the following:
 It may take some time for the command to complete, so be patient. Running
 the command with the ` -d` option displays information about its progress.
 
-The first argument specifies a _hello_ directory to be generated
-for your project. Its `www` subdirectory houses your application's
+The first argument _hello_ specifies a directory to be generated
+for your project. This directory should not already exist, Cordova will
+create it for you. Its `www` subdirectory houses your application's
 home page, along with various resources under `css`, `js`, and `img`,
 which follow common web development file-naming conventions. The
 `config.xml` file contains important metadata needed to generate and
 distribute the application.
 
-The other two arguments are optional: the `com.example.hello` argument
-provides your project with a reverse domain-style identifier, and the
-`HelloWorld` provides the application's display text. You can edit
-both of these values later in the `config.xml` file.
+The second argument `com.example.hello`
+provides your project with a reverse domain-style identifier. This argument
+is optional, but only if you also omit the third argument, since the arguments
+are positional. You can edit
+this value later in the `config.xml` file, but do be aware that there may
+be code generated outside of `config.xml` using this value, such as Java
+package names. The default value is `io.cordova.hellocordova`, but it is
+recommended that you select an appropriate value.
+
+The third argument `HelloWorld` provides the application's display title.
+This argument is optional. You can edit this value later in the `config.xml`
+file, but do be aware that there may be code generated outside of `config.xml`
+using this value, such as Java class names. The default value is `HelloCordova`,
+but it is recommended that you select an appropriate value.
 
 ## Add Platforms
 


Mime
View raw message