Skip to content
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.

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

Remove unused "verbose" field from gRPC Debug service request message #702

Merged
merged 1 commit into from May 13, 2020
Merged

Remove unused "verbose" field from gRPC Debug service request message #702

merged 1 commit into from May 13, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 13, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
    • (Generated gRPC documentation will automatically be updated to reflect this change on the docs deployment once the PR is merged)
  • What kind of change does this PR introduce?

Removal of unused field from gRPC service request message field. This feature has not been implemented, so the field has no purpose.

  • What is the current behavior?

The presence of a verbose field leads the user to believe this field can be used to control the verbosity of the debug command, whereas it actually has no effect.

  • What is the new behavior?

Debug service gRPC interface doesn't have an unused verbose field.

  • Does this PR introduce a breaking change?

This will be a breaking change for anyone using the verbose field. However, it's likely that few, if any, will be affected.

This feature has not been implemented, so the field has no purpose.
@per1234 per1234 merged commit b55722f into arduino:master May 13, 2020
@per1234 per1234 deleted the remove-grpc-debug-service-verbose-field branch May 13, 2020 07:56
@@ -53,8 +53,7 @@ message DebugConfigReq {
string sketch_path = 3;
string port = 4;
string interpreter = 5;
bool verbose = 6;
string import_file = 7;
string import_file = 6;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's ok to remove a field but do not change the numeric identifier of existing fields like in:

-    string import_file = 7;
+   string import_file = 6;

this provides a better backward compatibility (well, at least the "verbose" value won't go into "import_file" when using an old client). I'll fixi it while rebasing #687

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the information. I was following #689 as a reference, but without really knowing what I was doing.

@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants