Skip to content

Commit b79a965

Browse files
authored
Update compilerArgs description. (#10339)
1 parent 148a709 commit b79a965

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Extension/c_cpp_properties.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"type": "string"
2222
},
2323
"compilerArgs": {
24-
"markdownDescription": "Compiler arguments to modify the includes or defines used, e.g. `-nostdinc++`, `-m32`, etc.",
25-
"descriptionHint": "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered.",
24+
"markdownDescription": "Compiler arguments to modify the includes or defines used, e.g. `-nostdinc++`, `-m32`, etc. Arguments that take additional space-delimited arguments should be entered as separate arguments in the array, e.g. for `--sysroot <arg>` use `\"--sysroot\", \"<arg>\"`.",
25+
"descriptionHint": "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered, except potentially the `arg` text which is a placeholder and not literal text, i.e. an abbreviation for `argument`.",
2626
"type": "array",
2727
"items": {
2828
"type": "string"

Extension/ui/settings.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@
495495

496496
<div class="section">
497497
<div class="section-title" data-loc-id="compiler.args">Compiler arguments</div>
498-
<div class="section-text" data-loc-id="compiler.arguments">Compiler arguments to modify the includes or defines used, e.g. <code>-nostdinc++</code>, <code>-m32</code>, etc.</div>
498+
<div class="section-text" data-loc-id="compiler.arguments">Compiler arguments to modify the includes or defines used, e.g. <code>-nostdinc++</code>, <code>-m32</code>, etc. Arguments that take additional space-delimited arguments should be entered as separate arguments in the array, e.g. for <code>--sysroot &lt;arg&gt;</code> use <code>"--sysroot", "&lt;arg&gt;"</code>.</div>
499499
<div>
500500
<div class="section-note" data-loc-id="one.argument.per.line">One argument per line.</div>
501501
<textarea name="inputValue" id="compilerArgs" rows="4" cols="93" style="width: 800px"></textarea>

0 commit comments

Comments
 (0)