Skip to content

add documentation for non-vendored rust bindings #4549

Open
@jmayclin

Description

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

Activity

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

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions