Smaller docs improvements #2745
Conversation
tjanez
requested review from
kostko,
peterjgilbert,
pro-wh and
Yawning
as code owners
tjanez
force-pushed
the
tjanez/docs-improvements
branch
from
ebfafa3
to
df3d821
Compare
|
|
||
| ``` | ||
| cargo install fortanix-sgx-tools sgxs-tools | ||
| rustup target add x86_64-fortanix-unknown-sgx |
There was a problem hiding this comment.
why are the rustup target add and cargo install reversed from before?
There was a problem hiding this comment.
you only need the target for compiling to sgx. the sgx tools are binaries that compile to native. You'd be best off using rustup target add --toolchain nightly-2020-02-16 x86_64-fortanix-unknown-sgx if you don't set the default toolchain during the initial install.
There was a problem hiding this comment.
As @nhynes explained, the Fortanix SGX target is not needed for compiling the sgx tools, however, sgx tools are required for compiling to sgx.
I would like to avoid hard-coding a particular nightly version in the README because experience suggests we will forget to update it.
Hence, I tried to use such instructions that never need to specify a nightly version and only rely on the rust-toolchain file.
|
|
||
| ``` | ||
| rustup default nightly | ||
| curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh |
There was a problem hiding this comment.
| curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | |
| curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly |
if you're feeling terse. one could even go as far as saying --default-toolchain nightly-2020-02-16 -t x86_64-fortanix-unknown-sgx
There was a problem hiding this comment.
Thanks for the suggestions. I decided to leave it as is as I would prefer not to set the nightly as a default toolchain for all user's projects.
tjanez
force-pushed
the
tjanez/docs-improvements
branch
from
df3d821
to
f473316
Compare
Clarify instructions on setting up Rust and taking advantage of the newly added rust-toolchain file which rustup uses to download and install the correct version of the Rust toolchain automatically.
Currently, Oasis Labs' towncrier fork is unversioned and hence installing it from a git branch will not over-write a previous installation, even though there were new changes on the given branch. For more details, see: oasisprotocol/towncrier#6.
tjanez
force-pushed
the
tjanez/docs-improvements
branch
from
f473316
to
98bad8f
Compare
Mostly a clarification on how to set up Rust and take advantage of the newly added
rust-toolchainfile which rustup uses to download and install the correct version of the Rust toolchain automatically.