Skip to content

Commit

Permalink
Update docs on xargo usage
Browse files Browse the repository at this point in the history
  • Loading branch information
anupdhml committed Jun 4, 2020
1 parent 5528a9c commit 40e13c1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,10 @@ passthrough = [

### Use Xargo instead of Cargo

By default, `cross` uses `cargo` to build your Cargo project *unless* you are
building for one of the `thumbv*-none-eabi*` targets; in that case, it uses
`xargo`. However, you can use the `build.xargo` or `target.{{TARGET}}.xargo` field
in `Cross.toml` to force the use of `xargo`:
By default, `cross` uses `xargo` to build your Cargo project only for all
non-standard targets (i.e. something not reported by rustc/rustup). However,
you can use the `build.xargo` or `target.{{TARGET}}.xargo` field in
`Cross.toml` to force the use of `xargo`:

``` toml
# all the targets will use `xargo`
Expand All @@ -216,8 +216,8 @@ Or,
xargo = true
```

Note that `xargo = false` has no effect as you can't use `cargo` with targets
that only support `xargo`.
`xargo = false` will work the opposite way (pick cargo always) and is useful
when building for custom targets that you know to work with cargo.

## Supported targets

Expand Down

0 comments on commit 40e13c1

Please sign in to comment.