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

non-functional - re-run protoc to update comments #502

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

LarryRuane
Copy link
Collaborator

@LarryRuane LarryRuane commented Oct 15, 2024

This is a follow-on to PR #495, which changed the comments in service.proto but didn't regenerate service.pb.go. This commits re-runs protoc (the protobuf compiler) so the two are back in sync (but the changes were comments only).

Regenerating the protobuf files can be done by running make.

As a side note, it may have been better to not source-control these generated files (maybe we can do that in a future PR); the tradeoff is that the current approach doesn't require lightwalletd software developers to install protoc, whereas if we made that change, they would. (It's probably possible to have make install protoc, similar to how the zcashd build installs rust; this also ensures that the correct version of rust is used.)

In practice, it doesn't matter much either way, because the .proto files rarely change.

This PR also regenerates an HTML file that documents the gRPC interface, see https://zcash.readthedocs.io/en/latest/lightwalletd/index.html
It doesn't appear this is being maintained, or at least it's out of date, it doesn't include GetSubtreeRoots, for example.

This is a follow-on to PR 495, which changed the comments in
service.proto but didn't regenerate service.pb.go. This commits re-runs
protoc so the two are back in sync (but the changes were comments only).
@LarryRuane LarryRuane self-assigned this Oct 15, 2024
@LarryRuane LarryRuane changed the title non-functional change - re-run protoc to update comments non-functional - re-run protoc to update comments Oct 15, 2024
@LarryRuane
Copy link
Collaborator Author

I'm merging this because it's only comments and documentation.

@LarryRuane LarryRuane merged commit 9cba3e0 into zcash:master Oct 16, 2024
3 checks passed
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.

1 participant