From add9a9600ba1812df15f28473d72ed83f78a3586 Mon Sep 17 00:00:00 2001 From: Rajkumar Janakiraman Date: Tue, 7 Feb 2017 17:15:34 -0800 Subject: [PATCH] Adding pipeArgs documentation. (#1202) * Adding pipeArgs documentation. * Ran "gulp generateOptionsSchema" to update package.json. Fixed instructions in the readme.md --- package.json | 18 +++++++++--------- src/tools/OptionsSchema.json | 4 ++-- src/tools/README.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/package.json b/package.json index 0108e7338..e9ec95172 100644 --- 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 @@ } ] } -} +} \ No newline at end of file diff --git a/src/tools/OptionsSchema.json b/src/tools/OptionsSchema.json index 71b81eccf..62f52c114 100644 --- 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 index 7f2585c39..bab72413f 100644 --- 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