Skip to contentSkip to conversation

manual: add QEMU demo to quick start

PATCH Superseded Ciro Santilli 2 participants 3 messages Oct 10, 2018

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 manual: add QEMU demo to quick start

---
OK, me learning to ues crappy mailing lists now >:-), will this appear v2 on the same thread?

Your software is awesome, and many more people would see that if the quickstart actually told them how to quickstart and see something happen ;-)

 docs/manual/quickstart.txt | 36 +++++++++++++++++++++++++++++++-----
 1 file changed, 31 insertions(+), 5 deletions(-)
docs/manual/quickstart.txt +31 -5
index 74158ae249..00afe09e6b 100644
@@ -8,12 +8,38 @@ is no need to be root to configure and use Buildroot. By running all
 commands as a regular user, you protect your system against packages
 behaving badly during compilation and installation.
 
-The first step when using Buildroot is to create a configuration.
-Buildroot has a nice configuration tool similar to the one you can
-find in the http://www.kernel.org/[Linux kernel] or in
-http://www.busybox.net/[BusyBox].
+=== Try it out with QEMU
 
-From the buildroot directory, run
+If you just want to emulate a simple generic QEMU system to see
+Buildroot at work immediately, run from the buildroot directory:
+
+--------------------
+make qemu_x86_64_defconfig
+make BR2_JLEVEL="$(nproc)"
+qemu-system-x86_64 \
+  -M pc \
+  -kernel output/images/bzImage \
+  -drive file=output/images/rootfs.ext2,if=virtio,format=raw \
+  -append "root=/dev/vda" \
+  -net nic,model=virtio \
+  -net user
+--------------------
+
+Once QEMU boots, login with +root+, and you are now left inside a minimal
+BusyBox based Linux distribution.
+
+The initial build can take several minutes to a few hours since we download
+and compile GCC, the Linux kernel and other basic system components from
+source.
+
+The QEMU command to use is also documented at: +board/qemu/x86/readme.txt+
+
+=== Day-to-day workflow
+
+In your day-to-day workflow, the first step when using Buildroot is to
+create a custom configuration. Buildroot has a nice configuration tool
+similar to the one you can find in the http://www.kernel.org/[Linux kernel]
+or in http://www.busybox.net/[BusyBox]:
 
 --------------------
  $ make menuconfig
Signature · 1 line
2.19.0
#1 lore raw

PATCH v2 1/1 manual: add QEMU demo to quick start

Hello,

Quoted 1 line · Ciro Santilli

---

We need patches to have a Signed-off-by.

Quoted 7 lines

+=== Try it out with QEMU

docs/manual/quickstart.txt +4 -1
-From the buildroot directory, run
+If you just want to emulate a simple generic QEMU system to see
+Buildroot at work immediately, run from the buildroot directory:
+
+--------------------

docs/manual/quickstart.txt is no need to be root to configure and use Buildroot. By running all · line 26

Quoted 10 lines
docs/manual/quickstart.txt +10 -0
+make qemu_x86_64_defconfig
+make BR2_JLEVEL="$(nproc)"
+qemu-system-x86_64 \
+  -M pc \
+  -kernel output/images/bzImage \
+  -drive file=output/images/rootfs.ext2,if=virtio,format=raw \
+  -append "root=/dev/vda" \
+  -net nic,model=virtio \
+  -net user
+--------------------

We should point the user to board/qemu/x86-64/readme.txt instead.

Perhaps, we could make this a bit more generic, and point to all defconfigs and the associated readme.txt files ?

Best regards,

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

PATCH v2 1/1 manual: add QEMU demo to quick start

Quoted 19 lines · Thomas Petazzoni

Hello,

Quoted 1 line · Ciro Santilli

---

We need patches to have a Signed-off-by.

Quoted 11 lines

+=== Try it out with QEMU

docs/manual/quickstart.txt +8 -1
-From the buildroot directory, run
+If you just want to emulate a simple generic QEMU system to see
+Buildroot at work immediately, run from the buildroot directory:
+
+--------------------
+make qemu_x86_64_defconfig
+make BR2_JLEVEL="$(nproc)"
+qemu-system-x86_64 \
+  -M pc \
Quoted 9 lines

docs/manual/quickstart.txt is no need to be root to configure and use Buildroot. By running all · line 26

Quoted 6 lines
docs/manual/quickstart.txt +6 -0
+  -kernel output/images/bzImage \
+  -drive file=output/images/rootfs.ext2,if=virtio,format=raw \
+  -append "root=/dev/vda" \
+  -net nic,model=virtio \
+  -net user
+--------------------

We should point the user to board/qemu/x86-64/readme.txt instead.

Ah, now I understood this comment! I was confused because my previous patch referred to the wrong board/qemu/x86/readme.txt instead of x86_64, I thought it was meant to fix that, but it is on another line.

Quoted 10 lines

Perhaps, we could make this a bit more generic, and point to all defconfigs and the associated readme.txt files ?

Best regards,

Thomas
--
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com