You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by jsoref <gi...@git.apache.org> on 2014/08/20 20:14:52 UTC
[GitHub] cordova-cli pull request: CB-7345 improve cli documentation
GitHub user jsoref opened a pull request:
https://github.com/apache/cordova-cli/pull/188
CB-7345 improve cli documentation
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jsoref/cordova-cli cb_7345
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-cli/pull/188.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 #188
----
commit bc75de4dbd186beeb6319b7e8e63e78c306e6e33
Author: Josh Soref <js...@blackberry.com>
Date: 2014-08-20T17:04:22Z
CB-7345 improve cli documentation
commit 39405245c4906749e636d7f72ee1060a73f2c0e9
Author: Josh Soref <js...@blackberry.com>
Date: 2014-08-20T17:40:35Z
CB-7345 add tests to validate documentation
----
---
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.
---
[GitHub] cordova-cli pull request: CB-7345 improve cli documentation
Posted by clelland <gi...@git.apache.org>.
Github user clelland commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/188#discussion_r16498478
--- Diff: doc/cordova.txt ---
@@ -16,11 +16,15 @@ Project Commands
prepare ............................ Copy files into platform(s) for building
compile ............................ Build platform(s)
- build .............................. prepare + compile
run ................................ Run project
- emulate ............................ Run project with an emulator
+ (including prepare/compile)
serve .............................. Run project with a local webserver
+ (including prepare)
+
+aliases:
+ build -> cordova-cli prepare; cordova-cli compile
--- End diff --
More correctly, this is `cordova-cli prepare && cordova-cli compile`, since it should bail out if prepare fails (I think)
---
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.
---
[GitHub] cordova-cli pull request: CB-7345 improve cli documentation
Posted by clelland <gi...@git.apache.org>.
Github user clelland commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/188#discussion_r16498522
--- Diff: doc/cordova.txt ---
@@ -16,11 +16,15 @@ Project Commands
prepare ............................ Copy files into platform(s) for building
compile ............................ Build platform(s)
- build .............................. prepare + compile
run ................................ Run project
--- End diff --
Run includes prepare and compile as well -- not sure if this counts as 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.
---
[GitHub] cordova-cli pull request: CB-7345 improve cli documentation
Posted by clelland <gi...@git.apache.org>.
Github user clelland commented on a diff in the pull request:
https://github.com/apache/cordova-cli/pull/188#discussion_r16494980
--- Diff: doc/build.txt ---
@@ -1,8 +1,26 @@
Synopsis
- cordova-cli build [PLATFORM..] [-- [platformopts]]
+ cordova-cli build PROD TARGET EXP PLATS POPTS
--- End diff --
This is odd -- it moves the description of what is required / optional down to the lower section, rather than showing it in the one-liner. I'd probably prefer something like
cordova-cli build [PROD] [TARGET] [EXP] [PLATS] [-- [POPTS]]
PROD: --debug|--release
... etc
but that's a matter of preference. the bare "--", for instance, is really part of the overall command line, I think, not part of the platformopts, and it's almost hidden in the lower section.
---
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.
---
[GitHub] cordova-cli pull request: CB-7345 improve cli documentation
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-cli/pull/188
---
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.
---