Skip to content

Commit add9a96

Browse files
rajkumar42gregg-miskelly
rajkumar42
authored and
gregg-miskelly
committed
Adding pipeArgs documentation. (#1202)
* Adding pipeArgs documentation. * Ran "gulp generateOptionsSchema" to update package.json. Fixed instructions in the readme.md
1 parent e2622f6 commit add9a96

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

‎package.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -714,7 +714,7 @@
714714
},
715715
"pipeArgs": {
716716
"type": "array",
717-
"description": "Command line arguments passed to the pipe program.",
717+
"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.",
718718
"items": {
719719
"type": "string"
720720
},
@@ -754,7 +754,7 @@
754754
},
755755
"pipeArgs": {
756756
"type": "array",
757-
"description": "Command line arguments passed to the pipe program.",
757+
"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.",
758758
"items": {
759759
"type": "string"
760760
},
@@ -791,7 +791,7 @@
791791
},
792792
"pipeArgs": {
793793
"type": "array",
794-
"description": "Command line arguments passed to the pipe program.",
794+
"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.",
795795
"items": {
796796
"type": "string"
797797
},
@@ -828,7 +828,7 @@
828828
},
829829
"pipeArgs": {
830830
"type": "array",
831-
"description": "Command line arguments passed to the pipe program.",
831+
"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.",
832832
"items": {
833833
"type": "string"
834834
},
@@ -964,7 +964,7 @@
964964
},
965965
"pipeArgs": {
966966
"type": "array",
967-
"description": "Command line arguments passed to the pipe program.",
967+
"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.",
968968
"items": {
969969
"type": "string"
970970
},
@@ -1004,7 +1004,7 @@
10041004
},
10051005
"pipeArgs": {
10061006
"type": "array",
1007-
"description": "Command line arguments passed to the pipe program.",
1007+
"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.",
10081008
"items": {
10091009
"type": "string"
10101010
},
@@ -1041,7 +1041,7 @@
10411041
},
10421042
"pipeArgs": {
10431043
"type": "array",
1044-
"description": "Command line arguments passed to the pipe program.",
1044+
"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.",
10451045
"items": {
10461046
"type": "string"
10471047
},
@@ -1078,7 +1078,7 @@
10781078
},
10791079
"pipeArgs": {
10801080
"type": "array",
1081-
"description": "Command line arguments passed to the pipe program.",
1081+
"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.",
10821082
"items": {
10831083
"type": "string"
10841084
},
@@ -1151,4 +1151,4 @@
11511151
}
11521152
]
11531153
}
1154-
}
1154+
}

‎src/tools/OptionsSchema.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
},
2727
"pipeArgs": {
2828
"type": "array",
29-
"description": "Command line arguments passed to the pipe program.",
29+
"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.",
3030
"items": {
3131
"type": "string"
3232
},
@@ -64,7 +64,7 @@
6464
},
6565
"pipeArgs": {
6666
"type": "array",
67-
"description": "Command line arguments passed to the pipe program.",
67+
"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.",
6868
"items": {
6969
"type": "string"
7070
},

‎src/tools/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
OptionsSchema.json defines the type for Launch/Attach options.
33

44
# GenerateOptionsSchema
5-
If there are any modifications to the OptionsSchema.json file. Please run `gulp updateOptionsSchema` at the repo root.
5+
If there are any modifications to the OptionsSchema.json file. Please run `gulp generateOptionsSchema` at the repo root.
66
This will call GenerateOptionsSchema and update the package.json file.
77

88
**NOTE:** *Any manual changes to package.json's object.contributes.debuggers[0].configurationAttributes will be

0 commit comments

Comments
 (0)