Skip to content

Commit cc24b3a

Browse files
committed
add build-time helper that shows proper command
1 parent bb7896c commit cc24b3a

6 files changed

Lines changed: 32 additions & 5 deletions

File tree

.cargo/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ paths = [
4343
[alias]
4444
oro = [
4545
"run",
46+
"-p",
47+
"oro-kernel-build",
4648
"--offline",
4749
"--quiet",
4850
"--message-format",

Cargo.lock

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ path = "utils/empty.rs"
1010

1111
[workspace]
1212
resolver = "2"
13-
default-members = ["utils/build"]
13+
default-members = ["utils/build-help"]
1414
members = [
1515
"lib/*",
1616
"utils/*",

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,25 @@ All code necessary to build and run the kernel is provided in this repository.
2020
> It is not yet suitable for use in a production environment.
2121
2222
## Building
23-
The Oro kernel uses its own build system that runs in-situ with a normal
24-
`cargo build`. To build all possible versions of the kernel, simply run:
23+
The Oro kernel uses its own build utility called `cargo oro`.
24+
25+
To build all possible versions of the kernel and all booloaders, simply run:
2526

2627
```shell
2728
cargo oro build
2829
```
2930

30-
If you'd like to build a specific version of the kernel, you can specify
31-
the `--features` flag with the appropriate feature.
31+
To see all available build options, run:
32+
33+
```shell
34+
cargo oro build --help
35+
```
36+
37+
For all other operations, such as documenting, linting, vendoring, etc.:
38+
39+
```shell
40+
cargo oro --help
41+
```
3242

3343
## Documentation
3444
The Oro kernel is thoroughly documented. You may generate a local copy of

utils/build-help/Cargo.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[package]
2+
name = "oro-kernel-build-notice"
3+
version = "0.1.0"
4+
publish = false
5+
edition = "2024"

utils/build-help/src/main.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#[cfg(not(test))]
2+
compile_error!("run `cargo oro --help` instead");
3+
4+
fn main() {
5+
panic!("not sure how you built this, but this does nothing; run `cargo oro --help` instead");
6+
}

0 commit comments

Comments
 (0)