Skip to content

Commit 4c4a1f5

Browse files
authored
[skip changelog] Add documentation for gRPC Debug service (#703)
Comments added to the .proto files are included in the generated gRPC interface documentation.
1 parent ae41268 commit 4c4a1f5

File tree

2 files changed

+36
-7
lines changed

2 files changed

+36
-7
lines changed

Diff for: rpc/debug/debug.pb.go

+22-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: rpc/debug/debug.proto

+14
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import "commands/common.proto";
2323

2424
// Service that abstract a debug Session usage
2525
service Debug {
26+
// Start a debug session and communicate with the debugger tool.
2627
rpc Debug (stream DebugReq) returns (stream DebugResp) {
2728
}
2829
}
@@ -48,18 +49,31 @@ message DebugReq {
4849
}
4950

5051
message DebugConfigReq {
52+
// Arduino Core Service instance from the `Init` response.
5153
cc.arduino.cli.commands.Instance instance = 1;
54+
// Fully qualified board name of the board in use
55+
// (e.g., `arduino:samd:mkr1000`). If this is omitted, the FQBN attached to
56+
// the sketch will be used.
5257
string fqbn = 2;
58+
// Path to the sketch that is running on the board. The compiled executable
59+
// is expected to be located under this path.
5360
string sketch_path = 3;
61+
// Port of the debugger. Set to `none` if the debugger doesn't use a port.
5462
string port = 4;
63+
// Which GDB command interpreter to use.
5564
string interpreter = 5;
5665
// DEPRECATED: use import_dir instead
5766
string import_file = 7 [deprecated = true];
67+
// Directory containing the compiled executable. If `import_dir` is not
68+
// specified, the executable is assumed to be in
69+
// `{sketch_path}/build/{fqbn}/`.
5870
string import_dir = 8;
5971
}
6072

6173
//
6274
message DebugResp {
75+
// Incoming data from the debugger tool.
6376
bytes data = 1;
77+
// Incoming error output from the debugger tool.
6478
string error = 2;
6579
}

0 commit comments

Comments
 (0)