Skip to content

Commit

Permalink
README: fix the slightly misleading doc
Browse files Browse the repository at this point in the history
`make proto` command runs protocol generation based on the tools
installed on your local machine, which is not what really expected,
because tools can be outdated.

`make` calls a `make proto` from a container, so all tools are of
the correct versions.

This patch changes `make proto` to just `make`.

Signed-off-by: Roman Penyaev <r.peniaev@gmail.com>
  • Loading branch information
rouming authored and deitch committed Oct 13, 2023
1 parent cb3cb12 commit 363795a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import (
To make changes to this API, you:

1. Edit the specific `.proto` files in the [proto](./proto) directory, or create new ones, as desired.
1. Run `make proto` to generate the language-specific bindings and visualizations.
1. Run `make` to generate the language-specific bindings and visualizations.
1. Commit the changes to the `.proto` files and the generated files.

The Pull Request process for this repository will regenerate the language-specific bindings and visualizations,
Expand Down Expand Up @@ -74,7 +74,7 @@ make python

### Visualizations

In addition to the language-specific libraries, `make proto` generates visualizations of the protobuf structure,
In addition to the language-specific libraries, `make` generates visualizations of the protobuf structure,
beginning with the root of an edge device config. These are
available as `.svg`, `.dot` and `.png` as below. Click to zoom in.

Expand Down
2 changes: 1 addition & 1 deletion go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
To build, go to the root directory of this repository and:

```bash
make proto
make
```

To vendor the result into a downstream dependency, e.g. pillar, do the following:
Expand Down

0 comments on commit 363795a

Please sign in to comment.