Document Protocol Buffer Setup #8572
Conversation
|
Hi @Jenkins-J. Thanks for your PR. I'm waiting for a containerd member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
BUILDING.md
Outdated
| When generating source code from `.proto` files, containerd may rely on some external protocol buffer files. These external dependencies should be added to the `/usr/local/include` directory. | ||
|
|
||
| > **Note** | ||
| > To install the appropriate version of `protoc` and download any necessary external protocol buffer files, run the install script located at `script/setup/install-protobuf`. |
There was a problem hiding this comment.
If we are going to recommend this script, we can remove wget -c https://github.com/protocolbuffers.... in L49-L50.
If we continue to retain L49-L50, no need to recommend this script.
There was a problem hiding this comment.
I removed the wget command example. It makes more sense to me to point to the script as it will install the correct version of protoc and download any necessary external .proto files as well.
Document the protocol buffer setup script and make note of external proto files that must be added for successful generation. Signed-off-by: James Jenkins <James.Jenkins@ibm.com>
|
The change looks good to me. Re-running the failed ones. |
|
@kzys Is there anything I need to do to get the tests passing before this can be merged? |
…/main Merge upstream containerd/main at commit 5d1ab01 into ado fork-external/main Related work items: containerd#7944, containerd#8174, containerd#8334, containerd#8362, containerd#8572, containerd#8582, containerd#8588, containerd#8605, containerd#8606, containerd#8617, containerd#8619, containerd#8626, containerd#8627, containerd#8633, containerd#8637, containerd#8641, containerd#8643, containerd#8645, containerd#8652, containerd#8667, containerd#8672, containerd#8673, containerd#8676, containerd#8680, containerd#8684, containerd#8685, containerd#8692, containerd#8696, containerd#8697, containerd#8701, containerd#8708, containerd#8717, containerd#8726, containerd#8728, containerd#8729, containerd#8731, containerd#8732, containerd#8740, containerd#8752, containerd#8758, containerd#8762, containerd#8764
Document the protocol buffer setup script and make note of external proto files that must be added for successful generation. Addresses issue #8551.