Skip to content

Commit 62e9094

Browse files
author
alex079
committed
update settings description
1 parent 3dffbe1 commit 62e9094

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

package.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"type": "string",
3838
"default": "",
3939
"scope": "resource",
40-
"description": "Path to compiler executable (avr-c++)"
40+
"description": "Path to the compiler executable file (i.e. avr-c++). It is used to obtain the path to the bin folder and locate other executable files (avr-size and avr-objdump)."
4141
},
4242
"AVR.source.libraries": {
4343
"type": "array",
@@ -46,19 +46,19 @@
4646
},
4747
"default": [],
4848
"scope": "resource",
49-
"description": "Paths to folders containing source libraries"
49+
"description": "Paths to folders containing source libraries. The paths are used as base paths for compiler includes and for source file scanning to discover and compile dependencies. AVR GCC built-in headers do not need to be listed."
5050
},
5151
"AVR.source.scanning depth": {
5252
"type": "integer",
5353
"default": 2,
5454
"scope": "resource",
55-
"description": "Maximum depth of source directories scanning"
55+
"description": "Maximum depth of source and libraries folders scanning. This limit is used for scanning the root project folder and each library folder."
5656
},
5757
"AVR.source.highlight": {
5858
"type": "boolean",
5959
"default": false,
6060
"scope": "resource",
61-
"description": "Highlight errors and warnings from build terminal"
61+
"description": "Highlight errors and warnings from build terminal. After the build step is finished, the build problems can be marked in editors and in Problems view. By default this option is turned off, because the IDE can perform most of the checks before compilation."
6262
},
6363
"AVR.compiler.arguments": {
6464
"type": "array",
@@ -76,7 +76,7 @@
7676
"-pipe"
7777
],
7878
"scope": "resource",
79-
"description": "Compiler arguments"
79+
"description": "Compiler arguments. Applied when compiling source files into object files. One array item must contain exactly one argument, whitespace within the array items is preserved."
8080
},
8181
"AVR.linker.arguments": {
8282
"type": "array",
@@ -89,7 +89,7 @@
8989
"-pipe"
9090
],
9191
"scope": "resource",
92-
"description": "Linker arguments"
92+
"description": "Linker arguments. Applied when linking object files into an executable file. One array item must contain exactly one argument, whitespace within the array items is preserved."
9393
},
9494
"AVR.disassembler.arguments": {
9595
"type": "array",
@@ -103,7 +103,7 @@
103103
"--demangle"
104104
],
105105
"scope": "resource",
106-
"description": "avr-objdump arguments"
106+
"description": "Object dump arguments. Applied when producing assembler listing from an executable file. One array item must contain exactly one argument, whitespace within the array items is preserved."
107107
},
108108
"AVR.reporter.arguments": {
109109
"type": "array",
@@ -114,7 +114,7 @@
114114
"-A"
115115
],
116116
"scope": "resource",
117-
"description": "avr-size arguments"
117+
"description": "Size display arguments. Applied when reporting the size of an executable file, updated automatically when compiler path is updated. One array item must contain exactly one argument, whitespace within the array items is preserved."
118118
},
119119
"AVR.compiler.C standard": {
120120
"type": "string",
@@ -132,7 +132,7 @@
132132
"type": "string",
133133
"default": "",
134134
"scope": "resource",
135-
"description": "MCU type"
135+
"description": "MCU type name from the list provided by avrdude configuration."
136136
},
137137
"AVR.device.frequency": {
138138
"type": [
@@ -141,13 +141,13 @@
141141
],
142142
"default": null,
143143
"scope": "resource",
144-
"description": "MCU frequency"
144+
"description": "MCU frequency. When this parameter is set, it defines a value for F_CPU constant. This parameter value is displayed in the status bar but otherwise setting it is fully equivalent to adding '-DF_CPU=${frequency}UL' compiler argument."
145145
},
146146
"AVR.programmer.tool": {
147147
"type": "string",
148148
"default": "",
149149
"scope": "resource",
150-
"description": "Path to programmer tool (avrdude)"
150+
"description": "Path to programmer tool (avrdude). It is required to obtain the list of supported MCU types and programmer types."
151151
},
152152
"AVR.programmer.arguments": {
153153
"type": "array",
@@ -156,19 +156,19 @@
156156
},
157157
"default": [],
158158
"scope": "resource",
159-
"description": "Programmer arguments"
159+
"description": "Programmer arguments. Applied when uploading firmware to a device. One array item must contain exactly one argument, whitespace within the array items is preserved."
160160
},
161161
"AVR.programmer.definitions": {
162162
"type": "string",
163163
"default": "",
164164
"scope": "resource",
165-
"description": "Path to programmer definitions (avrdude.conf)"
165+
"description": "Path to programmer definitions (avrdude.conf). This parameter overrides default definitions from user profile folder or from avrdude folder."
166166
},
167167
"AVR.programmer.type": {
168168
"type": "string",
169169
"default": "",
170170
"scope": "resource",
171-
"description": "Programmer type"
171+
"description": "Programmer type name from the list provided by avrdude configuration."
172172
},
173173
"AVR.programmer.port": {
174174
"type": "string",

0 commit comments

Comments
 (0)