CB-11982 : revised config command wording so it's clearer

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

Branch: refs/heads/master
Commit: 9053ed00e0bab71a26c3d634e07494ec61696f25
Parents: d34e596
Author: Audrey So <[email protected]>
Authored: Thu Mar 23 11:13:30 2017 -0700
Committer: Steve Gill <[email protected]>
Committed: Wed Apr 19 14:34:53 2017 -0700

----------------------------------------------------------------------
 doc/config.txt  | 19 +++++++++++--------
 doc/cordova.txt |  3 +--
 2 files changed, 12 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9053ed00/doc/config.txt
----------------------------------------------------------------------
diff --git a/doc/config.txt b/doc/config.txt
index 6eb017d..607452e 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -3,8 +3,7 @@ Synopsis
     cordova-cli config <command> [options]
     
 
-The config command can be used to set, get, delete, edit, and list the 
-contents of the user files.
+The config command can be used to set, get, delete, edit, and list global 
cordova options.
 
 Options
 --set <key> <value> .............................. Sets the config key to the  
                                                                                
                                                           value.If value is 
omitted,                                                                        
                                                                      then it 
sets it to "true".
@@ -13,10 +12,14 @@ Options
 --edit ........................................... Opens the config file in an 
                                                                                
                                                                   editor.
 --ls ............................................. Lists contents of config 
file.
 
-Example
+Syntax
+       cordova-cli config set <key> <value> ....... cordova config set 
autosave true
+       cordova-cli config get <key> ............... cordova config get autosave
+       cordova-cli config delete <key> ............ cordova config delete 
autosave
+       cordova-cli config edit .................... cordova config edit
+       cordova-cli config ls ...................... cordova config ls
 
-cordova-cli config set <key> <value> --> cordova config set autosave true
-cordova-cli config get <key>            --> cordova config get autosave
-cordova-cli config delete <key>                 --> cordova config delete 
autosave
-cordova-cli config edit                         --> cordova config edit
-cordova-cli config ls                           --> cordova config ls
+Examples
+       cordova config set autosave false
+       cordova config set browserify true
+       cordova config set fetch false

http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9053ed00/doc/cordova.txt
----------------------------------------------------------------------
diff --git a/doc/cordova.txt b/doc/cordova.txt
index f54d8ac..e9bd0b0 100644
--- a/doc/cordova.txt
+++ b/doc/cordova.txt
@@ -6,8 +6,7 @@ Global Commands
     create ............................. Create a project
     help ............................... Get help for a command
     telemetry .......................... Turn telemetry collection on or off
-    config ............................. Store and retrieve environment 
variables 
-                                         (set, get, delete, edit, list)
+    config ............................. Set, get, delete, edit, and list 
global cordova options
 
 Project Commands
     info ............................... Generate project information


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to