Add comments to justfile commands

This commit is contained in:
Berkus Decker 2020-11-12 15:20:03 +02:00
parent 09003a7da2
commit f07f130132
1 changed files with 9 additions and 0 deletions

View File

@ -1,7 +1,9 @@
qemu: qemu:
# Build and run kernel in QEMU
cargo make qemu cargo make qemu
device: device:
# Build and write kernel to an SD Card
cargo make sdcard cargo make sdcard
build: build:
@ -9,27 +11,34 @@ build:
cargo make build cargo make build
clean: clean:
# Clean project
cargo make clean cargo make clean
rm -f kernel8 kernel8.img rm -f kernel8 kernel8.img
clippy: clippy:
# Run clippy checks
cargo make clippy cargo make clippy
test: test:
# Run tests in QEMU
cargo make test cargo make test
alias disasm := hopper alias disasm := hopper
hopper: hopper:
# Build and disassemble kernel
cargo make hopper cargo make hopper
alias ocd := openocd alias ocd := openocd
openocd: openocd:
# Start openocd (by default connected via JTAG to a target device)
cargo make openocd cargo make openocd
gdb: gdb:
# Build and run kernel in GDB using openocd or QEMU as target (gdb port 5555)
cargo make gdb cargo make gdb
nm: nm:
# Build and print all symbols in the kernel
cargo make nm cargo make nm