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

Document installation of cargo subcommand elf2sgxs #4476

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/setup/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,20 @@ Core:
rustup target add x86_64-fortanix-unknown-sgx
```

* (**OPTIONAL**) [oasis-core-tools].

Required to use the `cargo` subcommand `elf2sgxs` when building for SGX, to
convert ELF binaries to SGXS format.

Download and install it with:

```
cargo install oasis-core-tools \
--git https://github.com/oasisprotocol/oasis-core \
--force \
--locked
```

* (**OPTIONAL**) [gofumpt] and [goimports].

Required if you plan to change any of the Go code in order for automated code
Expand Down Expand Up @@ -247,6 +261,7 @@ where the code has been checked out.
[jemalloc-hardcode-path]:
https://github.com/dgraph-io/ristretto/blob/221ca9b2091d12e5d24aa5d7d56e49745fc175d8/z/calloc_jemalloc.go#L9-L13
<!-- markdownlint-enable line-length -->
[oasis-core-tools]: https://github.com/oasisprotocol/oasis-core/tree/master/tools

## Using the Development Docker Image

Expand Down