From c2578cd9a17897356d7776a9704155548fad3709 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 20 Dec 2021 15:45:36 +0000 Subject: [PATCH] docs: Clarify where to run agent API generation commands Make it clear when reading the table in the agent's "Change the agent API" documentation that the commands in the "Generation method" column should be run in the agent repo. Fixes: #3317. Signed-off-by: James O. D. Hunt --- src/agent/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/agent/README.md b/src/agent/README.md index 24161cebed..97b6acc071 100644 --- a/src/agent/README.md +++ b/src/agent/README.md @@ -63,11 +63,15 @@ The Kata runtime communicates with the Kata agent using a ttRPC based API protoc This ttRPC API is defined by a set of [protocol buffers files](protocols/protos). The protocol files are used to generate the bindings for the following components: -| Component | Language | Generation method | Tooling required | +| Component | Language | Generation method `[*]` | Tooling required | |-|-|-|-| | runtime | Golang | Run, `make generate-protocols` | `protoc` | | agent | Rust | Run, `make` | | +> **Key:** +> +> `[*]` - All commands must be run in the agent repository. + If you wish to change the API, these files must be regenerated. Although the rust code will be automatically generated by the [build script](protocols/build.rs),