10000 [pluggable monitor] add documentation by cmaglie · Pull Request #1499 · arduino/arduino-cli · GitHub
[go: up one dir, main page]
Skip to content

[pluggable monitor] add documentation #1499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 7, 2021
Merged

[pluggable monitor] add documentation #1499

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5cef06
Added documentation for pluggable monitor
cmaglie Oct 6, 2021
c8599ac
Apply suggestions from code review
cmaglie Oct 7, 2021
d959ba2
Add pluggable monitor spec in nav bar; fixed link in source code comm…
cmaglie Oct 7, 2021
f6fd38a
fix i18n and lint warnings
cmaglie Oct 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix i18n and lint warnings
  • Loading branch information
@cmaglie
cmaglie committed Oct 7, 2021
commit f6fd38abcb24bb290e5e0cbc2e217e0024f46538
22 changes: 11 additions & 11 deletions arduino/cores/cores.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ type PlatformRelease struct {
ToolDependencies ToolDependencies
DiscoveryDependencies DiscoveryDependencies
MonitorDependencies MonitorDependencies
Help PlatformReleaseHelp `json:"-"`
Platform *Platform `json:"-"`
Properties *properties.Map `json:"-"`
Boards map[string]*Board `json:"-"`
Programmers map[string]*Programmer `json:"-"`
Menus *properties.Map `json:"-"`
InstallDir *paths.Path `json:"-"`
IsIDEBundled bool `json:"-"`
IsTrusted bool `json:"-"`
PluggableDiscoveryAware bool `json:"-"` // true if the Platform supports pluggable discovery (no compatibility layer required)
Monitors map[string]*MonitorDependency
Help PlatformReleaseHelp `json:"-"`
Platform *Platform `json:"-"`
Properties *properties.Map `json:"-"`
Boards map[string]*Board `json:"-"`
Programmers map[string]*Programmer `json:"-"`
Menus *properties.Map `json:"-"`
InstallDir *paths.Path `json:"-"`
IsIDEBundled bool `json:"-"`
IsTrusted bool `json:"-"`
PluggableDiscoveryAware bool `json:"-"` // true if the Platform supports pluggable discovery (no compatibility layer required)
Monitors map[string]*MonitorDependency `json:"-"`
}

// BoardManifest contains information about a board. These metadata are usually
Expand Down
3 changes: 2 additions & 1 deletion arduino/monitor/monitor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

// Documentation about pluggable monitor is available here:
// Package monitor provides a client for Pluggable Monitors.
// Documentation is available here:
// https://arduino.github.io/arduino-cli/latest/pluggable-monitor-specification/
package monitor

Expand Down
8 changes: 4 additions & 4 deletions i18n/data/en.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2503,7 +2503,7 @@ msgstr "cleaning build path"
msgid "command"
msgstr "command"

#: arduino/monitor/monitor.go:157
#: arduino/monitor/monitor.go:150
msgid "command '%[1]s' failed: %[2]s"
msgstr "command '%[1]s' failed: %[2]s"

Expand All @@ -2516,7 +2516,7 @@ msgstr "command '%[1]s' failed: %[2]s"
msgid "command failed: %s"
msgstr "command failed: %s"

#: arduino/monitor/monitor.go:154
#: arduino/monitor/monitor.go:147
msgid "communication out of sync, expected '%[1]s', received '%[2]s'"
msgstr "communication out of sync, expected '%[1]s', received '%[2]s'"

Expand Down Expand Up @@ -3110,7 +3110,7 @@ msgstr "port"
msgid "port not found: %[1]s %[2]s"
msgstr "port not found: %[1]s %[2]s"

#: arduino/monitor/monitor.go:246
#: arduino/monitor/monitor.go:239
msgid "protocol version not supported: requested %[1]d, got %[2]d"
msgstr "protocol version not supported: requested %[1]d, got %[2]d"

Expand Down Expand Up @@ -3300,7 +3300,7 @@ msgstr "the platform has no releases"
msgid "the server responded with status %s"
msgstr "the server responded with status %s"

#: arduino/monitor/monitor.go:147
#: arduino/monitor/monitor.go:140
msgid "timeout waiting for message"
msgstr "timeout waiting for message"

Expand Down
8 changes: 4 additions & 4 deletions i18n/rice-box.go
View file
Open in desktop

Large diffs are not rendered by default.

0