Skip to content

Commit

Permalink
Update documentation as requested in reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Guillemard committed Aug 7, 2019
1 parent 88c28fb commit d1c1fe9
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 12 deletions.
4 changes: 0 additions & 4 deletions bootstrap/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ version = "0.1.0"
license = "Apache-2.0 OR MIT"
edition = "2018"

[package.metadata.cargo-xbuild]
memcpy = true
sysroot_path = "target/sysroot"

[dependencies]
sunrise-libutils = { path = "../libutils" }
bit_field = "0.10.0"
Expand Down
4 changes: 2 additions & 2 deletions docs/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you don't want to (or can't) use `rustup`, you should check the `rust-toolcha

## Build orchestration

`cargo-make` is used to orchestrate the build. It can be installed through `cargo install cargo-make`. Check out the [versions section](#versions) to find out what the minimum version of cargo-xbuild is necessary to build SunriseOS.
`cargo-make` is used to orchestrate the build. It can be installed through `cargo install cargo-make`. Check out the [versions section](#versions) to find out what the minimum version of xrago is necessary to build SunriseOS.

`cargo-make` will install all the other tools necessary to properly build SunriseOS. Note that `cargo-make` won't attempt to update already installed tools. If the build fails, check out the [versions section](#versions) and ensure all the tools are installed and have the appropriate version.

Expand All @@ -26,7 +26,7 @@ First, ensure you have qemu installed, as `cargo-make` will not automatically in
- clippy
- rust-src
- cargo-make: `0.20.0`
- cargo-xbuild: `0.5.14`
- xargo: `0.3.14`
- mkisofs-rs: `0.1.0`
- qemu-system-i386: `4.0.50`
- cargo-travis: `https://github.com/roblabla/cargo-travis` branch `doc-upload-target`
2 changes: 1 addition & 1 deletion docs/UPDATE_RUST.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We will occasionally want to update the version of the Rust Compiler we use in o
- rust-std
- rustc
2. Set the `rust-toolchain` file at the root of the repo to `nightly-$LATEST_VER`. For instance, if the latest version to support all the requirements is 2019-07-15, then set the rust-toolchain file to `nightly-2019-07-15`.
3. Update `cargo-xbuild` to the latest version. It likely contains fixes for latest rust changes (there are breaking changes to `no_std` builds from time to time).
3. Update `xargo` to the latest version. It likely contains fixes for latest rust changes (there are breaking changes to `no_std` builds from time to time).
4. Compile the whole project, and fix all the errors.
5. Update the `BUILDING.md` with the new minimum versions.

Expand Down
5 changes: 0 additions & 5 deletions kernel/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ version = "0.1.0"
license = "Apache-2.0 OR MIT"
edition = "2018"

[package.metadata.cargo-xbuild]
memcpy = true
sysroot_path = "target/sysroot"


[features]
#Will make the kernel panic if an exception is encountered. Useful for debugging.
panic-on-exception = []
Expand Down

0 comments on commit d1c1fe9

Please sign in to comment.