Add more docs on how to run the generator

- Note that working directory matters
- Note that stdarch-gen-arm uses nightly
- Fix missing directory. Without this, it would print to stdout in one
  giant merged file.
This commit is contained in:
Jynn Nelson
2026-03-19 13:43:40 +01:00
parent a72aceea2b
commit dc3ba83196
@@ -1,11 +1,11 @@
# stdarch-gen-arm generator guide
## Running the generator
- Run: `cargo run --bin=stdarch-gen-arm -- crates/stdarch-gen-arm/spec`
```
$ cargo run --bin=stdarch-gen-arm -- crates/stdarch-gen-arm/spec
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.18s
Running `target/debug/stdarch-gen-arm crates/stdarch-gen-arm/spec`
```
Run: `cargo +nightly run --bin=stdarch-gen-arm -- crates/stdarch-gen-arm/spec crates/core_arch/src`
NOTE: If you are running this from rust-lang/rust, you must be in the `library/stdarch`
working directory.
## Input/Output
### Input files (intrinsic YAML definitions)
- `crates/stdarch-gen-arm/spec/<feature>/*.spec.yml`