Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README should mention the pinned version of boringssl #92

Open
roblabla opened this issue Oct 24, 2022 · 1 comment
Open

README should mention the pinned version of boringssl #92

roblabla opened this issue Oct 24, 2022 · 1 comment

Comments

@roblabla
Copy link
Contributor

Currently, the README says the following:

By default, the crate statically links with the latest BoringSSL master branch.

After reviewing the code, I think this is a bit misleading. By default, the crate statically links with a pinned version of boringssl, currently set to google/boringssl@f1c7534 .

I think it'd be valuable to make this clearer in the README. After reading the current README, I initially thought it was dynamically fetching the latest version of boringssl in its build.rs. In fact, there is a call to git submodule in a build.rs, but it seems to only run when depending on boring via git!

It'd be nice to have a few lines in the README clearly spelling out that, by default, the crate pins a specific boringssl version (and thus doesn't break reproducibility).

@jyn514
Copy link
Contributor

jyn514 commented Oct 27, 2022

Yes, sounds like a good improvement :) happy to take a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants