You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by nikhilkh <gi...@git.apache.org> on 2016/01/26 21:16:54 UTC
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
GitHub user nikhilkh opened a pull request:
https://github.com/apache/cordova-cli/pull/232
Update help docs - add examples and make them consistent
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MSOpenTech/cordova-cli docsReword
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-cli/pull/232.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #232
----
commit b586c674768f3ed90a0c2fb5ef12dbcceca1cc8f
Author: Nikhil Khandelwal <ni...@microsoft.com>
Date: 2016-01-25T23:09:44Z
Update help docs - add examples and make them consistent
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50896685
--- Diff: doc/clean.txt ---
@@ -6,3 +6,6 @@ Cleans the build artifacts for the specified platform, or all platforms
by running platform-provided clean script.
To provide platform specific options, you must include them after `--`.
+
+Example
+ corodva-cli clean android
--- End diff --
Fixed
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50895262
--- Diff: doc/cordova.txt ---
@@ -1,14 +1,11 @@
Synopsis
-
--- End diff --
Maybe somewhere here, we should mention that the user can get more info about command 'x' by running: `cordova x --help`
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50894159
--- Diff: doc/cordova.txt ---
@@ -24,16 +21,21 @@ Project Commands
(including prepare && compile)
serve .............................. Run project with a local webserver
(including prepare)
-
-aliases:
+Aliases
build -> cordova-cli prepare && cordova-cli compile
emulate -> cordova-cli run --emulator
-Command-line Flags/Options
-
+Options
-v, --version ...................... prints out this utility's version
-d, --verbose ...................... debug mode produces verbose log output for all activity,
- including output of sub-commands cordova-cli invokes
--no-update-notifier ............... disables check for CLI updates
--nohooks .......................... suppress executing hooks
- (taking RegExp hook patterns as parameters)
+ (taking RegExp hook patterns as parameters)
+
+Examples
+ cordova-cli create myApp org.apache.cordova.myApp myApp
+ cordova-cli plugin add cordova-plugin-camera --save
+ cordova-cli platform add android --save
+ cordova-cli requirements android
+ cordova-cli buid android --verbose
--- End diff --
buid should be build
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50895834
--- Diff: doc/plugin.txt ---
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
+ --save ......................... Save the information for specified plugin into config.xml
+ --shrinkwrap ................... Used together with --save, saves the
+ installed version numbers to config.xml
+ --browserify ................... Compile plugin JS at build time using
+ browserify instead of runtime.
+
+ remove <pluginid>|<name> [...] ..... Remove plugins with the given IDs/name.
- [--save] ................................... remove the information for specified plugin into config.xml
+ --save ......................... Remove the information for specified plugin into config.xml
+
+ list .............................. List currently installed plugins
+ search [<keyword>] [...] .......... Search http://plugins.cordova.io for plugins matching the keywords
+
+Syntax
+ <plugin-spec> : <pluginID>[@<version>]|<directory>|<url>[#<commit-ish>]
- list .......................................... list currently installed plugins
- search [<keyword>] [...] ...................... search the plugin registry for plugins matching the keywords
+ <plugin> .......................... Plugin id (id of plugin in npm registry or --searchPath)
+ <directory> ....................... Directory containing plugin.xml
+ <url> ............................. Url to a git repository containing a plugin.xml
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
-aliases:
+Aliases
plugins -> plugin
rm -> remove
ls -> list
-
-Experimental Flags
-
- --browserify .......................... Plugins javascript gets loaded at build time instead of runtime using browserify.
- Replaces cordovajs file with one that includes the JS of the installed plugins.
+Examples
--- End diff --
Again, may be an example with more than one plugin and using flags with it.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50898933
--- Diff: doc/build.txt ---
@@ -22,12 +22,11 @@ all/the specified platforms.
--buildConfig....................... Use the specified build configuration
instead of default build.json
- --browserify ....................... Compile plugin JS at build time instead of runtime
- using browserify. Replaces cordovajs file with one
- that includes the JS of the installed plugins.
-
+ --browserify ....................... Compile plugin JS at build time using
--- End diff --
A typical Cordova project has multiple plugins,
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50894956
--- Diff: doc/compile.txt ---
@@ -18,3 +20,8 @@ Builds the app for specified platforms, or all platforms
--target ........................... Deploy to a specific target
To provide platform specific options, you must include them after `--`.
+
+Examples
+
+ cordova-cli compile android windows --debug --device
+ cordova-cli compile android --release
--- End diff --
It would be a good idea to include an example for one of the platform specific options
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50895227
--- Diff: doc/platform.txt ---
@@ -4,48 +4,45 @@ Synopsis
Manage project platforms
- add <plat-spec> [...].............. add specified platforms
- --save ........................ save specified platforms into config.xml after installing them
+ add <plat-spec> [...].............. Add specified platforms
+ --save ........................ Save specified platforms into config.xml after installing them
- --link ........................ when <plat-spec> is a local path, links the platform
+ --link ........................ When <plat-spec> is a local path, links the platform
library directly instead of making a copy of it (support
varies by platform; useful for platform development)
- remove <platform> [...] ........... remove specified platforms
- --save ........................ delete specified platforms from config.xml after removing them
+ remove <platform> [...] ........... Remove specified platforms
+ --save ........................ Delete specified platforms from config.xml after removing them
- list .............................. list all installed and available platforms
- update <plat-spec> ................ update the version of Cordova used for a specific platform;
- update to the latest <version> if no <version>, <path> or <url> is specified
+ update <plat-spec> ................ Update the version of Cordova used for a specific platform;
+ update to the latest <version> if no <plat-spec> is specified
- --save ........................ save the latest versions for specified platforms into config.xml
+ --save ........................ Save the latest versions for specified platforms into config.xml
- check ............................. list platforms which can be updated by `cordova-cli platform update`
+ list .............................. List all installed and available platforms
+ check ............................. List platforms which can be updated by `cordova-cli platform update`
Syntax
- <plat-spec>:
- <platform-ver>|<path>|<git-url>
-
- <platform-ver>:
- <platform>[@<version>]
-
- <git-url>:
- <url>[#<branch>]
-
- <platform> ........................ platform (typically from npm registry)
-
- <path> ............................ path to a directory containing a platform
- name of platform to be retrieved from npm registry
-
- <url> ............................. url to a git repository containing a platform
-
- <version> ......................... major.minor.patch version specifier
-
- <branch> .......................... name of the branch to checkout after cloning the git repo
- if none is specified, the 'master' branch will be checked out
-aliases:
+ <plat-spec> : <platform>[@<version>]|<path>|<url>[#<commit-ish>]
+
+ <platform> ........................ Platform name e.g. android, ios, windows etc.
+ <path> ............................ Path to a directory containing a platform
+ <url> ............................. Url to a git repository containing a platform
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
+
+Aliases
platforms -> platform
rm -> remove
ls -> list
+
+Examples
--- End diff --
Can we have an example for multiple platform add/delete as well?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897654
--- Diff: doc/plugin.txt ---
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
--- End diff --
+1 to @riknoll explanation.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50899381
--- Diff: doc/compile.txt ---
@@ -18,3 +20,8 @@ Builds the app for specified platforms, or all platforms
--target ........................... Deploy to a specific target
To provide platform specific options, you must include them after `--`.
+
+Examples
+
+ cordova-cli compile android windows --debug --device
+ cordova-cli compile android --release
--- End diff --
Added in 'build' and top-level help.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-cli/pull/232
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897060
--- Diff: doc/cordova.txt ---
@@ -24,16 +21,21 @@ Project Commands
(including prepare && compile)
serve .............................. Run project with a local webserver
(including prepare)
-
-aliases:
+Aliases
build -> cordova-cli prepare && cordova-cli compile
emulate -> cordova-cli run --emulator
-Command-line Flags/Options
-
+Options
-v, --version ...................... prints out this utility's version
-d, --verbose ...................... debug mode produces verbose log output for all activity,
- including output of sub-commands cordova-cli invokes
--no-update-notifier ............... disables check for CLI updates
--nohooks .......................... suppress executing hooks
- (taking RegExp hook patterns as parameters)
+ (taking RegExp hook patterns as parameters)
+
+Examples
+ cordova-cli create myApp org.apache.cordova.myApp myApp
+ cordova-cli plugin add cordova-plugin-camera --save
+ cordova-cli platform add android --save
+ cordova-cli requirements android
+ cordova-cli buid android --verbose
--- End diff --
Fixed!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on the pull request:
https://github.com/apache/cordova-cli/pull/232#issuecomment-175248507
LGTM.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50895529
--- Diff: doc/plugin.txt ---
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
--- End diff --
What is the significance of 'Useful for plugin development'?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50895798
--- Diff: doc/platform.txt ---
@@ -4,48 +4,45 @@ Synopsis
Manage project platforms
- add <plat-spec> [...].............. add specified platforms
- --save ........................ save specified platforms into config.xml after installing them
+ add <plat-spec> [...].............. Add specified platforms
+ --save ........................ Save specified platforms into config.xml after installing them
- --link ........................ when <plat-spec> is a local path, links the platform
+ --link ........................ When <plat-spec> is a local path, links the platform
library directly instead of making a copy of it (support
varies by platform; useful for platform development)
- remove <platform> [...] ........... remove specified platforms
- --save ........................ delete specified platforms from config.xml after removing them
+ remove <platform> [...] ........... Remove specified platforms
+ --save ........................ Delete specified platforms from config.xml after removing them
- list .............................. list all installed and available platforms
- update <plat-spec> ................ update the version of Cordova used for a specific platform;
- update to the latest <version> if no <version>, <path> or <url> is specified
+ update <plat-spec> ................ Update the version of Cordova used for a specific platform;
+ update to the latest <version> if no <plat-spec> is specified
- --save ........................ save the latest versions for specified platforms into config.xml
+ --save ........................ Save the latest versions for specified platforms into config.xml
- check ............................. list platforms which can be updated by `cordova-cli platform update`
+ list .............................. List all installed and available platforms
+ check ............................. List platforms which can be updated by `cordova-cli platform update`
Syntax
- <plat-spec>:
- <platform-ver>|<path>|<git-url>
-
- <platform-ver>:
- <platform>[@<version>]
-
- <git-url>:
- <url>[#<branch>]
-
- <platform> ........................ platform (typically from npm registry)
-
- <path> ............................ path to a directory containing a platform
- name of platform to be retrieved from npm registry
-
- <url> ............................. url to a git repository containing a platform
-
- <version> ......................... major.minor.patch version specifier
-
- <branch> .......................... name of the branch to checkout after cloning the git repo
- if none is specified, the 'master' branch will be checked out
-aliases:
+ <plat-spec> : <platform>[@<version>]|<path>|<url>[#<commit-ish>]
+
+ <platform> ........................ Platform name e.g. android, ios, windows etc.
+ <path> ............................ Path to a directory containing a platform
+ <url> ............................. Url to a git repository containing a platform
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
--- End diff --
'Commit/tag/branch'
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50896043
--- Diff: doc/plugin.txt ---
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
--- End diff --
That flag is only really useful for plugin development. It lets you debug your plugin in a project. For Android, that means you can actually open your code in Android Studio (otherwise, the project wouldn't include all of the cordova-android java code). I say leave it in.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897541
--- Diff: doc/platform.txt ---
@@ -4,48 +4,45 @@ Synopsis
Manage project platforms
- add <plat-spec> [...].............. add specified platforms
- --save ........................ save specified platforms into config.xml after installing them
+ add <plat-spec> [...].............. Add specified platforms
+ --save ........................ Save specified platforms into config.xml after installing them
- --link ........................ when <plat-spec> is a local path, links the platform
+ --link ........................ When <plat-spec> is a local path, links the platform
library directly instead of making a copy of it (support
varies by platform; useful for platform development)
- remove <platform> [...] ........... remove specified platforms
- --save ........................ delete specified platforms from config.xml after removing them
+ remove <platform> [...] ........... Remove specified platforms
+ --save ........................ Delete specified platforms from config.xml after removing them
- list .............................. list all installed and available platforms
- update <plat-spec> ................ update the version of Cordova used for a specific platform;
- update to the latest <version> if no <version>, <path> or <url> is specified
+ update <plat-spec> ................ Update the version of Cordova used for a specific platform;
+ update to the latest <version> if no <plat-spec> is specified
- --save ........................ save the latest versions for specified platforms into config.xml
+ --save ........................ Save the latest versions for specified platforms into config.xml
- check ............................. list platforms which can be updated by `cordova-cli platform update`
+ list .............................. List all installed and available platforms
+ check ............................. List platforms which can be updated by `cordova-cli platform update`
Syntax
- <plat-spec>:
- <platform-ver>|<path>|<git-url>
-
- <platform-ver>:
- <platform>[@<version>]
-
- <git-url>:
- <url>[#<branch>]
-
- <platform> ........................ platform (typically from npm registry)
-
- <path> ............................ path to a directory containing a platform
- name of platform to be retrieved from npm registry
-
- <url> ............................. url to a git repository containing a platform
-
- <version> ......................... major.minor.patch version specifier
-
- <branch> .......................... name of the branch to checkout after cloning the git repo
- if none is specified, the 'master' branch will be checked out
-aliases:
+ <plat-spec> : <platform>[@<version>]|<path>|<url>[#<commit-ish>]
+
+ <platform> ........................ Platform name e.g. android, ios, windows etc.
+ <path> ............................ Path to a directory containing a platform
+ <url> ............................. Url to a git repository containing a platform
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
+
+Aliases
platforms -> platform
rm -> remove
ls -> list
+
+Examples
--- End diff --
Done for add - rm should be obvious
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50894379
--- Diff: doc/build.txt ---
@@ -22,12 +22,11 @@ all/the specified platforms.
--buildConfig....................... Use the specified build configuration
instead of default build.json
- --browserify ....................... Compile plugin JS at build time instead of runtime
- using browserify. Replaces cordovajs file with one
- that includes the JS of the installed plugins.
-
+ --browserify ....................... Compile plugin JS at build time using
--- End diff --
'plugin JS' => 'plugins' JS'
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897700
--- Diff: doc/plugin.txt ---
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
+ --save ......................... Save the information for specified plugin into config.xml
+ --shrinkwrap ................... Used together with --save, saves the
+ installed version numbers to config.xml
+ --browserify ................... Compile plugin JS at build time using
+ browserify instead of runtime.
+
+ remove <pluginid>|<name> [...] ..... Remove plugins with the given IDs/name.
- [--save] ................................... remove the information for specified plugin into config.xml
+ --save ......................... Remove the information for specified plugin into config.xml
+
+ list .............................. List currently installed plugins
+ search [<keyword>] [...] .......... Search http://plugins.cordova.io for plugins matching the keywords
+
+Syntax
+ <plugin-spec> : <pluginID>[@<version>]|<directory>|<url>[#<commit-ish>]
- list .......................................... list currently installed plugins
- search [<keyword>] [...] ...................... search the plugin registry for plugins matching the keywords
+ <plugin> .......................... Plugin id (id of plugin in npm registry or --searchPath)
+ <directory> ....................... Directory containing plugin.xml
+ <url> ............................. Url to a git repository containing a plugin.xml
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
-aliases:
+Aliases
plugins -> plugin
rm -> remove
ls -> list
-
-Experimental Flags
-
- --browserify .......................... Plugins javascript gets loaded at build time instead of runtime using browserify.
- Replaces cordovajs file with one that includes the JS of the installed plugins.
+Examples
--- End diff --
Done!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50896722
--- Diff: doc/build.txt ---
@@ -22,12 +22,11 @@ all/the specified platforms.
--buildConfig....................... Use the specified build configuration
instead of default build.json
- --browserify ....................... Compile plugin JS at build time instead of runtime
- using browserify. Replaces cordovajs file with one
- that includes the JS of the installed plugins.
-
+ --browserify ....................... Compile plugin JS at build time using
--- End diff --
Eh - not sure about this one. It's arguable.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-cli/pull/232#issuecomment-175208219
@Rakatyal could you please review?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on the pull request:
https://github.com/apache/cordova-cli/pull/232#issuecomment-175210221
why 'cordova-cli' instead of 'cordova' ?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897339
--- Diff: doc/emulate.txt ---
@@ -2,6 +2,6 @@ Synopsis
cordova-cli emulate [PLATFORM...] [-- [platformopts]]
-Alias for `cordova-cli run --emulator`
+Alias for `cordova-cli run --emulator`. Use 'cordova-cli help run' for details on options.
--- End diff --
I don't think so. As I see it, this itself is an alias.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50894618
--- Diff: doc/clean.txt ---
@@ -6,3 +6,6 @@ Cleans the build artifacts for the specified platform, or all platforms
by running platform-provided clean script.
To provide platform specific options, you must include them after `--`.
+
+Example
+ corodva-cli clean android
--- End diff --
'corodva-cli' => 'cordova-cli'
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897041
--- Diff: doc/cordova.txt ---
@@ -1,14 +1,11 @@
Synopsis
-
--- End diff --
Good point - added!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50897419
--- Diff: doc/platform.txt ---
@@ -4,48 +4,45 @@ Synopsis
Manage project platforms
- add <plat-spec> [...].............. add specified platforms
- --save ........................ save specified platforms into config.xml after installing them
+ add <plat-spec> [...].............. Add specified platforms
+ --save ........................ Save specified platforms into config.xml after installing them
- --link ........................ when <plat-spec> is a local path, links the platform
+ --link ........................ When <plat-spec> is a local path, links the platform
library directly instead of making a copy of it (support
varies by platform; useful for platform development)
- remove <platform> [...] ........... remove specified platforms
- --save ........................ delete specified platforms from config.xml after removing them
+ remove <platform> [...] ........... Remove specified platforms
+ --save ........................ Delete specified platforms from config.xml after removing them
- list .............................. list all installed and available platforms
- update <plat-spec> ................ update the version of Cordova used for a specific platform;
- update to the latest <version> if no <version>, <path> or <url> is specified
+ update <plat-spec> ................ Update the version of Cordova used for a specific platform;
+ update to the latest <version> if no <plat-spec> is specified
- --save ........................ save the latest versions for specified platforms into config.xml
+ --save ........................ Save the latest versions for specified platforms into config.xml
- check ............................. list platforms which can be updated by `cordova-cli platform update`
+ list .............................. List all installed and available platforms
+ check ............................. List platforms which can be updated by `cordova-cli platform update`
Syntax
- <plat-spec>:
- <platform-ver>|<path>|<git-url>
-
- <platform-ver>:
- <platform>[@<version>]
-
- <git-url>:
- <url>[#<branch>]
-
- <platform> ........................ platform (typically from npm registry)
-
- <path> ............................ path to a directory containing a platform
- name of platform to be retrieved from npm registry
-
- <url> ............................. url to a git repository containing a platform
-
- <version> ......................... major.minor.patch version specifier
-
- <branch> .......................... name of the branch to checkout after cloning the git repo
- if none is specified, the 'master' branch will be checked out
-aliases:
+ <plat-spec> : <platform>[@<version>]|<path>|<url>[#<commit-ish>]
+
+ <platform> ........................ Platform name e.g. android, ios, windows etc.
+ <path> ............................ Path to a directory containing a platform
+ <url> ............................. Url to a git repository containing a platform
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
--- End diff --
Fixed!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-cli pull request: Update help docs - add examples and make...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/232#discussion_r50894344
--- Diff: doc/emulate.txt ---
@@ -2,6 +2,6 @@ Synopsis
cordova-cli emulate [PLATFORM...] [-- [platformopts]]
-Alias for `cordova-cli run --emulator`
+Alias for `cordova-cli run --emulator`. Use 'cordova-cli help run' for details on options.
--- End diff --
Should this be under an Aliases heading, as in cordova.txt?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org