diff options
| author | Tianhao Wang <shrik3@mailbox.org> | 2024-04-19 00:22:02 +0200 |
|---|---|---|
| committer | Tianhao Wang <shrik3@mailbox.org> | 2024-06-11 15:16:35 +0200 |
| commit | 52df1531cf37895b17c073a58a25a71cf479467b (patch) | |
| tree | 01cd12875a95d7f4b494816f86cac96f583a7153 /README.md | |
| parent | 2578105f6e365b43ee6dbb4770555ccf3089c2b9 (diff) | |
update readme for troubleshooting
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 25 insertions, 2 deletions
@@ -49,9 +49,23 @@ Beyond the original StuBS Please take a look at the CI manifest: `.builds/x86_64.yml` +**build dependencies** +- rust toolchain: `nightly-x86_64-unknown-linux-gnu` +- `cargo xbuild`, install with: + ``` + $ cargo install xbuild + ``` +- `rustfmt`, this should be shipped with your rust/cargo installation. If not, + install with + ``` + $ cargo install rustfmt + ``` +- `GNU ld (GNU Binutils)` +- `nasm` +- `xorriso` and `grub` to create bootdisk image. + + **general dependencies:** -- cargo / rustc (nightly) -- xbuild for crossbuild - basics: nasm, make, glibc, ld etc. - xorriso and grub (to create bootable image) - qemu-system-x86_64 (optional for simulation) @@ -65,6 +79,15 @@ Please take a look at the CI manifest: bare metal - use `make qemu` to load and test the iso image with qemu +**troubleshooting** +- cargo xbuild hangs: try updating the default toolchain and rebuilding xbuild. +- `ld (Gnu Binutils) <=2.39` do not support `--no-warn-rwx-segments` flag. If + that's your case, remove it from the `LDFLAGS` in `Makefile` +- `grub-mkrescue` fails if you don't have the `piglatin` locale available. + Either pick one locale you have, or remove the `--locale` option for + `grub-mkrescue` in `Makefile`. (If you don't specify one locale, all will be + installed, resulting in a unnecessarily huge image). + ## Structure ``` . |