Skip to content

Commit 8e03699

Browse files
committed
prebuilt: tell users to checkout ot latest tag, otherwise too unstable
1 parent 65d33ab commit 8e03699

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.adoc

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,9 @@ Our prebuilts currently include:
498498
* Linux kernel
499499
* root filesystem
500500

501-
Advantage: saves time and disk space on the initial install, which is expensive in largely due to building the toolchain.
501+
For more details, see our our <<release,release procedure>>.
502+
503+
Advantage of this setup: saves time and disk space on the initial install, which is expensive in largely due to building the toolchain.
502504

503505
The limitations are severe however:
504506

@@ -522,18 +524,21 @@ This setup might be good enough for those developing simulators, as that require
522524

523525
==== Prebuilt Buildroot setup getting started
524526

525-
Some times it works with the host QEMU:
527+
Checkout to the latest tag and use the Ubuntu packaged QEMU:
526528

527529
....
528530
sudo apt-get install qemu-system-x86
529531
git clone https://github.com/cirosantilli/linux-kernel-module-cheat
530532
cd linux-kernel-module-cheat
533+
git checkout "$(git rev-list --tags --max-count=1)"
531534
./release-download-latest
532535
unzip lkmc-*.zip
533536
./run --prebuilt
534537
....
535538

536-
but to be sure, build your own at a tested revision:
539+
You have to checkout to the latest tag to ensure that the scripts match the release format: https://stackoverflow.com/questions/1404796/how-to-get-the-latest-tag-name-in-current-branch-in-git
540+
541+
Be saner and use our custom built QEMU instead:
537542

538543
....
539544
git submodule update --init --recursive "$(./getvar qemu_src_dir)"
@@ -543,16 +548,7 @@ git submodule update --init --recursive "$(./getvar qemu_src_dir)"
543548

544549
This also allows you to <<your-first-qemu-hack,modify QEMU>> if you're into that sort of thing.
545550

546-
To try an older prebuilt:
547-
548-
* download it from: link:https://github.com/cirosantilli/linux-kernel-module-cheat/releases[]
549-
* checkout this repo to match the SHA of the release
550-
551-
then do whatever that checked out README says.
552-
553-
If you are curious to see what the releases contain in detail, have a look at our <<release,release procedure>>.
554-
555-
To build the kernel modules, simply do:
551+
To build the kernel modules as in <<your-first-kernel-module-hack>> do:
556552

557553
....
558554
./build-linux -- modules_prepare
@@ -562,6 +558,8 @@ To build the kernel modules, simply do:
562558

563559
`modules_prepare` does the minimal build procedure required on the kernel for us to be able to compile the kernel modules, and is way faster than doing a full kernel build. A full kernel build would also work however.
564560

561+
This command automatically falls back to the Ubuntu packaged GCC since you don't have the Buildroot toolchain.
562+
565563
To modify the Linux kernel, build and use it as usual:
566564

567565
....

0 commit comments

Comments
 (0)