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

add documentation for non-vendored rust bindings #4549

Open
jmayclin opened this issue May 9, 2024 · 0 comments
Open

add documentation for non-vendored rust bindings #4549

jmayclin opened this issue May 9, 2024 · 0 comments

Comments

@jmayclin
Copy link
Contributor

jmayclin commented May 9, 2024

Problem:

s2n-tls bindings provide an option to use an existing libs2n artifact.

export S2N_TLS_LIB_DIR=`pwd`/build/lib
export S2N_TLS_INCLUDE_DIR=`pwd`/api
export LD_LIBRARY_PATH=$S2N_TLS_LIB_DIR:$LD_LIBRARY_PATH
cd ${{env.ROOT_PATH}}
./generate.sh
ldd target/debug/integration | grep libs2n.so

However this option doesn't really have any documentation.

Solution:

We should add documentation. Ideally in a place in the readme (so it shows up on crates.io) or in a place so that it shows up on docs.rs

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

No branches or pull requests

2 participants