|
1 | 1 | # Envoy Proto Collect |
2 | 2 |
|
3 | | -This crate is a tool used to collect selected proto files from the repos |
4 | | -contained in the `submodules` directory, adding said files to the repo's |
5 | | -`envoy-types/proto` directory. |
| 3 | +This crate is a tool used to collect selected proto files from the repos contained in the |
| 4 | +`submodules` directory, adding said files to the repo's `envoy-types/proto` directory. |
6 | 5 |
|
7 | | -Besides that, `Apache-2.0` declarations are added to the top of the proto files |
8 | | -lacking them. |
| 6 | +Besides that, `Apache-2.0` declarations are added to the top of the proto files lacking them. |
9 | 7 |
|
10 | 8 | ## Run the Proto Collection Tool |
11 | 9 |
|
12 | | -First, delete the contents of the repo's `envoy-types/proto` directory, to |
13 | | -ensure that only the protos that were just collected are present in the |
14 | | -directory by the end of the process. |
| 10 | +First, delete the contents of the repo's `envoy-types/proto` directory, to ensure that only the |
| 11 | +protos that were just collected are present in the directory by the end of the process. |
15 | 12 |
|
16 | 13 | Then, run the tool: |
17 | 14 |
|
18 | 15 | ```bash |
19 | 16 | $ cargo run --bin collect-protos |
20 | 17 | ``` |
21 | 18 |
|
22 | | -The compilation of the protos can be achieved by running the `bootstrap` test |
23 | | -of the `envoy-types` crate. This can be done by simply running: |
| 19 | +The compilation of the protos can be achieved by running the `bootstrap` test of the `envoy-types` |
| 20 | +crate. This can be done by simply running: |
24 | 21 |
|
25 | 22 | ```bash |
26 | 23 | $ cargo test bootstrap |
27 | 24 | ``` |
28 | 25 |
|
29 | | -On the repo's root directory. If `git` detects any changes in the resulting |
30 | | -generated files, the test will fail. |
| 26 | +On the repo's root directory. If `git` detects any changes in the resulting generated files, the |
| 27 | +test will fail. |
0 commit comments