You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation hosted at arduino.github.io/arduino-cli is versioned, with the URL determining which version is loaded:
- arduino.github.io/arduino-cli/0.20 - documentation content at the time of the latest release of the 0.20.x series
- arduino.github.io/arduino-cli/latest - documentation content at the time of the latest release
- arduino.github.io/arduino-cli/dev - documentation content at the tip of the default branch
Previously, some of the links displayed to users by Arduino Lint were pointing at the "dev" version of that
documentation. Since it may not apply to the release versions, or be in an unstable state, the "dev" version of the
documentation should only be used by Arduino CLI developers and beta testers. For this reason, the "latest" version will
be most appropriate for the users of Arduino Lint.
Copy file name to clipboardExpand all lines: internal/rule/ruleconfiguration/ruleconfiguration.go
+4-4
Original file line number
Diff line number
Diff line change
@@ -185,7 +185,7 @@ var configurations = []Type{
185
185
Subcategory: "source code",
186
186
ID: "LS008",
187
187
Brief: "name-header mismatch",
188
-
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/dev/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
188
+
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/latest/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
189
189
MessageTemplate: "No header file found matching library name ({{.}}). Best practices are for primary header filename to match library name.",
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/dev/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
562
+
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
563
563
MessageTemplate: "Library name {{.}} not found in the Library Manager index. Library names are not allowed to change after being added to the index.",
@@ -2907,7 +2907,7 @@ var configurations = []Type{
2907
2907
Brief: "upload.field.FIELD_NAME > max length",
2908
2908
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME` property in the platform's `platform.txt` configuration file is longer than the maximum length.",
2909
2909
MessageTemplate: "upload.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME property is longer than the maximum length for fields: {{.}}",
@@ -2924,7 +2924,7 @@ var configurations = []Type{
2924
2924
Brief: "upload.field.FIELD_NAME.secret invalid",
2925
2925
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret` property in the platform's `platform.txt` configuration file has an invalid value.",
2926
2926
MessageTemplate: "tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret value is invalid or field(s) {{.}}",
0 commit comments