Skip to content

Commit f4a6274

Browse files
committed
Document support for platforms
The platform support is now near to complete, so worth mentioning.
1 parent 84bb4ea commit f4a6274

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
- Sketches
1010
- Libraries
11+
- Boards platforms
1112

1213
## Documentation
1314

internal/cli/cli.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ func Root() *cobra.Command {
3434
rootCommand.PersistentFlags().String("compliance", "specification", "Configure how strict the tool is. Can be {strict|specification|permissive}")
3535
rootCommand.PersistentFlags().String("format", "text", "The output format can be {text|json}.")
3636
rootCommand.PersistentFlags().String("library-manager", "", "Configure the rules for libraries in the Arduino Library Manager index. Can be {submit|update|false}.\nsubmit: Also run additional rules required to pass before a library is accepted for inclusion in the index.\nupdate: Also run additional rules required to pass before new releases of a library already in the index are accepted.\nfalse: Don't run any Library Manager-specific rules.")
37-
rootCommand.PersistentFlags().String("project-type", "all", "Only check projects of the specified type and their subprojects. Can be {sketch|library|all}.")
37+
rootCommand.PersistentFlags().String("project-type", "all", "Only check projects of the specified type and their subprojects. Can be {sketch|library|platform|all}.")
3838
rootCommand.PersistentFlags().Bool("recursive", false, "Search path recursively for Arduino projects to check. Can be {true|false}.")
3939
rootCommand.PersistentFlags().String("report-file", "", "Save a report on the rules to this file.")
4040
rootCommand.PersistentFlags().BoolP("verbose", "v", false, "Show more information while running rules.")

internal/rule/rulefunction/platform.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1218,7 +1218,7 @@ func PlatformTxtRecipeSOPatternExtraFlagsSupport() (result ruleresult.Type, outp
12181218
return ruleresult.Pass, ""
12191219
}
12201220

1221-
// PlatformTxtRecipeArPatternMissing checks for missing recipe.ar.o.pattern property in platform.txt.
1221+
// PlatformTxtRecipeArPatternMissing checks for missing recipe.ar.pattern property in platform.txt.
12221222
func PlatformTxtRecipeArPatternMissing() (result ruleresult.Type, output string) {
12231223
if !projectdata.PlatformTxtExists() {
12241224
return ruleresult.Skip, "Platform has no platform.txt"
@@ -1256,7 +1256,7 @@ func PlatformTxtRecipeArPatternLTMinLength() (result ruleresult.Type, output str
12561256
return ruleresult.Pass, ""
12571257
}
12581258

1259-
// PlatformTxtRecipeArPatternExtraFlagsSupport checks if platform.txt recipe.ar.o.pattern provides support for user extra flags.
1259+
// PlatformTxtRecipeArPatternExtraFlagsSupport checks if platform.txt recipe.ar.pattern provides support for user extra flags.
12601260
func PlatformTxtRecipeArPatternExtraFlagsSupport() (result ruleresult.Type, output string) {
12611261
if !projectdata.PlatformTxtExists() {
12621262
return ruleresult.Skip, "Platform has no platform.txt"

0 commit comments

Comments
 (0)