Skip to content

Commit 7e5f343

Browse files
committed
Update Readme and help messages for new build-command config key
1 parent 058439b commit 7e5f343

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

Readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Now you can build the kernel project and create a bootable disk image from it by
3131
cargo bootimage --target your_custom_target.json [other_args]
3232
```
3333

34-
The command will invoke [`cargo xbuild`](https://github.com/rust-osdev/cargo-xbuild), forwarding all passed options. Then it will build the specified bootloader together with the kernel to create a bootable disk image.
34+
The command will invoke `cargo build`, forwarding all passed options. Then it will build the specified bootloader together with the kernel to create a bootable disk image.
3535

3636
### Running
3737

@@ -60,6 +60,10 @@ Configuration is done through a through a `[package.metadata.bootimage]` table i
6060

6161
```toml
6262
[package.metadata.bootimage]
63+
# The cargo subcommand that will be used for building the kernel.
64+
#
65+
# For building using the `cargo-xbuild` crate, set this to `xbuild`.
66+
build-command = ["build"]
6367
# The command invoked with the created bootimage (the "{}" will be replaced
6468
# with the path to the bootable disk image)
6569
# Applies to `bootimage run` and `bootimage runner`

src/help/cargo_bootimage_help.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,13 @@ BUILD_OPTS:
1111
is downloaded and built, and then combined with the kernel into a bootable
1212
disk image.
1313

14+
CONFIGURATION:
15+
The behavior of `cargo bootimage` can be configured through a
16+
`[package.metadata.bootimage]` table in the `Cargo.toml`. The
17+
following options are available to configure the build behavior:
18+
19+
[package.metadata.bootimage]
20+
# The cargo subcommand that will be used for building the kernel.
21+
#
22+
# For building using the `cargo-xbuild` crate, set this to `xbuild`.
23+
build-command = ["build"]

0 commit comments

Comments
 (0)