chore(cargo): add config.toml file
#3443
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
we use the `kubert` crate to export a collection of metrics measuring the behavior of our asynchronous tokio runtime. in order for this crate to compile, one must set a compile-time flag. this can be done either by setting the `RUSTFLAGS` environment variable, or via a toml file in `.cargo/config.toml`. helpful links: - <https://github.com/olix0r/kubert?tab=readme-ov-file#kubert-prometheus-tokio> - <https://docs.rs/tokio-metrics/latest/tokio_metrics/> - <https://doc.rust-lang.org/cargo/reference/config.html#buildrustflags> this commit introduces a file providing this `rustflags` flag. note that, per the cargo reference (linked above), the environment variable takes precedence over the value provided in the `config.toml` file. so, providing this flag here will allow a conventional `cargo build` to build the project successfully without setting any environment variables, without interfering with users' ability to provide additional compiler flags when needed. Signed-off-by: katelyn martin <kate@buoyant.io>
|
In general, I don't think we should commit .cargo/config.toml -- this file can be used for other settings that definitely should not be committed. Would it be suitable to include |
cratelyn
added a commit
that referenced
this pull request
Dec 11, 2024
this commit supercedes #3443. we use the kubert crate to export a collection of metrics measuring the behavior of our asynchronous tokio runtime. in order for this crate to compile, one must set a compile-time flag. this can be done either by setting the RUSTFLAGS environment variable, or via a toml file in .cargo/config.toml. helpful links: - <https://github.com/olix0r/kubert?tab=readme-ov-file#kubert-prometheus-tokio> - <https://docs.rs/tokio-metrics/latest/tokio_metrics/> - <https://doc.rust-lang.org/cargo/reference/config.html#buildrustflags> this commit adds `.cargo` to the repository's gitignore, so that people may freely modify cargo configuration as needed when building the project from source. Signed-off-by: katelyn martin <kate@buoyant.io>
|
that works well enough for my uses! i've opened #3451, i'll go ahead and close this now. |
cratelyn
added a commit
that referenced
this pull request
Dec 11, 2024
this commit supercedes #3443. we use the kubert crate to export a collection of metrics measuring the behavior of our asynchronous tokio runtime. in order for this crate to compile, one must set a compile-time flag. this can be done either by setting the RUSTFLAGS environment variable, or via a toml file in .cargo/config.toml. helpful links: - <https://github.com/olix0r/kubert?tab=readme-ov-file#kubert-prometheus-tokio> - <https://docs.rs/tokio-metrics/latest/tokio_metrics/> - <https://doc.rust-lang.org/cargo/reference/config.html#buildrustflags> this commit adds `.cargo` to the repository's gitignore, so that people may freely modify cargo configuration as needed when building the project from source. Signed-off-by: katelyn martin <kate@buoyant.io>
cratelyn
added a commit
that referenced
this pull request
Dec 11, 2024
this commit supercedes #3443. we use the kubert crate to export a collection of metrics measuring the behavior of our asynchronous tokio runtime. in order for this crate to compile, one must set a compile-time flag. this can be done either by setting the RUSTFLAGS environment variable, or via a toml file in .cargo/config.toml. helpful links: - <https://github.com/olix0r/kubert?tab=readme-ov-file#kubert-prometheus-tokio> - <https://docs.rs/tokio-metrics/latest/tokio_metrics/> - <https://doc.rust-lang.org/cargo/reference/config.html#buildrustflags> this commit adds `.cargo` to the repository's gitignore, so that people may freely modify cargo configuration as needed when building the project from source. Signed-off-by: katelyn martin <kate@buoyant.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
we use the
kubertcrate to export a collection of metrics measuring the behavior of our asynchronous tokio runtime.in order for this crate to compile, one must set a compile-time flag. this can be done either by setting the
RUSTFLAGSenvironment variable, or via a toml file in.cargo/config.toml.helpful links:
this commit introduces a file providing this
rustflagsflag.note that, per the cargo reference (linked above), the environment variable takes precedence over the value provided in the
config.tomlfile.so, providing this flag here will allow a conventional
cargo buildto build the project successfully without setting any environment variables, without interfering with users' ability to provide additional compiler flags when needed.