Adding pipeArgs documentation. (#1202)

* Adding pipeArgs documentation. * Ran "gulp generateOptionsSchema" to update package.json. Fixed instructions in the readme.md
dotnet · Feb 8, 2017 · add9a96 · add9a96
1 parent e2622f6
commit add9a96
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/package.json b/package.json
@@ -714,7 +714,7 @@
                   },
                   "pipeArgs": {
                     "type": "array",
-                    "description": "Command line arguments passed to the pipe program.",
+                    "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                     "items": {
                       "type": "string"
                     },
@@ -754,7 +754,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -791,7 +791,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -828,7 +828,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -964,7 +964,7 @@
                   },
                   "pipeArgs": {
                     "type": "array",
-                    "description": "Command line arguments passed to the pipe program.",
+                    "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                     "items": {
                       "type": "string"
                     },
@@ -1004,7 +1004,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -1041,7 +1041,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -1078,7 +1078,7 @@
                       },
                       "pipeArgs": {
                         "type": "array",
-                        "description": "Command line arguments passed to the pipe program.",
+                        "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                         "items": {
                           "type": "string"
                         },
@@ -1151,4 +1151,4 @@
       }
     ]
   }
-}
+}
diff --git a/src/tools/OptionsSchema.json b/src/tools/OptionsSchema.json
@@ -26,7 +26,7 @@
                 },
                 "pipeArgs": {
                     "type": "array",
-                    "description": "Command line arguments passed to the pipe program.",
+                    "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                     "items": {
                         "type": "string"
                     },
@@ -64,7 +64,7 @@
                 },
                 "pipeArgs": {
                     "type": "array",
-                    "description": "Command line arguments passed to the pipe program.",
+                    "description": "Command line arguments passed to the pipe program. Token ${debuggerCommand} in pipeArgs will get replaced by the full debugger command, this token can be specified inline with other arguments. If ${debuggerCommand} isn’t used in any argument, the full debugger command will be instead be added to the end of the argument list.",
                     "items": {
                         "type": "string"
                     },

diff --git a/src/tools/README.md b/src/tools/README.md
@@ -2,7 +2,7 @@
 OptionsSchema.json defines the type for Launch/Attach options.
 
 # GenerateOptionsSchema
-If there are any modifications to the OptionsSchema.json file. Please run `gulp updateOptionsSchema` at the repo root.
+If there are any modifications to the OptionsSchema.json file. Please run `gulp generateOptionsSchema` at the repo root.
 This will call GenerateOptionsSchema and update the package.json file. 
 
 **NOTE:** *Any manual changes to package.json's object.contributes.debuggers[0].configurationAttributes will be