All of lore.kernel.org
 help / color / mirror / Atom feed
From: Romain Naour <romain.naour@smile.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH v4 5/9] board/qemu: add defconfig file name as tag before the qemu command line
Date: Mon, 10 Feb 2020 14:37:27 +0100	[thread overview]
Message-ID: <cccdab0a-73d4-3409-275e-a1b8b3422643@smile.fr> (raw)
In-Reply-To: <20200210140839.4dab48c8@windsurf>

Hi Thomas,

Le 10/02/2020 ? 14:08, Thomas Petazzoni a ?crit?:
> Hello,
> 
> On Sun,  9 Feb 2020 19:03:23 +0100
> Romain Naour <romain.naour@smile.fr> wrote:
> 
>> diff --git a/board/qemu/aarch64-virt/readme.txt b/board/qemu/aarch64-virt/readme.txt
>> index f868905d91..3443de05a8 100644
>> --- a/board/qemu/aarch64-virt/readme.txt
>> +++ b/board/qemu/aarch64-virt/readme.txt
>> @@ -1,6 +1,6 @@
>>  Run the emulation with:
>>  
>> -  qemu-system-aarch64 -M virt -cpu cortex-a53 -nographic -smp 1 -kernel output/images/Image -append "rootwait root=/dev/vda console=ttyAMA0" -netdev user,id=eth0 -device virtio-net-device,netdev=eth0 -drive file=output/images/rootfs.ext4,if=none,format=raw,id=hd0 -device virtio-blk-device,drive=hd0
>> +qemu_aarch64_virt_defconfig: qemu-system-aarch64 -M virt -cpu cortex-a53 -nographic -smp 1 -kernel output/images/Image -append "rootwait root=/dev/vda console=ttyAMA0" -netdev user,id=eth0 -device virtio-net-device,netdev=eth0 -drive file=output/images/rootfs.ext4,if=none,format=raw,id=hd0 -device virtio-blk-device,drive=hd0
> 
> While I understand the idea, I believe this will potentially cause some
> confusing for newcomers just getting started with Buildroot, and
> potentially not too familiar with Linux.
> 
> Indeed, when one sees:
> 
> """
> Run the emulation with:
> 
> SOME COMPLICATED COMMAND
> """
> 
> One will clearly copy/paste "SOME COMPLICATED COMMAND", and here it
> won't work anymore. So I understand that adding this metadata helps you
> grepping through the readme.txt file to find the right command, but it
> makes the instructions less directly usable by their original target:
> newcomers to Buildroot.
> 
> One less bad option is to do it like this:
> 
> qemu-system-aarch64 -M virt -cpu cortex-a53 -nographic -smp 1 -kernel output/images/Image -append "rootwait root=/dev/vda console=ttyAMA0" -netdev user,id=eth0 -device virtio-net-device,netdev=eth0 -drive file=output/images/rootfs.ext4,if=none,format=raw,id=hd0 -device virtio-blk-device,drive=hd0 # qemu_aarch64_virt_defconfig
> 
> This way, the information is still encoded on the same line, but it's a
> comment, so if a newcomer copy/pastes that command line, it will really
> work.

Ok, I see your point.

I did this way since the qemu cmd line can be on several lines (see
board/qemu/arm-vexpress-tz/readme.txt).

Do we require that the qemu cmd line must be on one line ?

Best regards,
Romain

> 
> Best regards,
> 
> Thomas
> 

  reply	other threads:[~2020-02-10 13:37 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-09 18:03 [Buildroot] [PATCH v4 0/9] gitlab Qemu runtime testing Romain Naour
2020-02-09 18:03 ` [Buildroot] [PATCH v4 1/9] configs/qemu_ppc_mac99_defconfig: add usual comments for Kconfig symbols Romain Naour
2020-02-10  2:32   ` Joel Stanley
2020-02-16 21:22   ` Peter Korsgaard
2020-02-09 18:03 ` [Buildroot] [PATCH v4 2/9] configs/qemu_pcc_mac99: build host-qemu for runtime testing Romain Naour
2020-02-10  2:31   ` Joel Stanley
2020-02-16 21:23   ` Peter Korsgaard
2020-02-09 18:03 ` [Buildroot] [PATCH v4 3/9] configs/qemu_m68k_q800: remove host-qemu Romain Naour
2020-02-09 18:12   ` Romain Naour
2020-02-09 18:49     ` Romain Naour
2020-02-16 21:24       ` Peter Korsgaard
2020-02-09 18:03 ` [Buildroot] [PATCH v4 4/9] configs/qemu{x86, x86_64}: add a serial console Romain Naour
2020-02-16 21:28   ` Peter Korsgaard
2020-02-09 18:03 ` [Buildroot] [PATCH v4 5/9] board/qemu: add defconfig file name as tag before the qemu command line Romain Naour
2020-02-10 13:08   ` Thomas Petazzoni
2020-02-10 13:37     ` Romain Naour [this message]
2020-02-10 14:40       ` Thomas Petazzoni
2020-02-09 18:03 ` [Buildroot] [PATCH v4 6/9] board/qemu: add post-image script for gitlab qemu testing Romain Naour
2020-02-10 13:09   ` Thomas Petazzoni
2020-02-10 13:47     ` Romain Naour
2020-02-10 14:41       ` Thomas Petazzoni
2020-02-10 13:13   ` Thomas Petazzoni
2020-02-10 13:49     ` Romain Naour
2020-02-09 18:03 ` [Buildroot] [PATCH v4 7/9] configs/qemu*: use the post-image script with "$(BR2_DEFCONFIG)" as argument Romain Naour
2020-02-09 18:03 ` [Buildroot] [PATCH v4 8/9] support/scripts/boot-qemu-image.py: boot Qemu images with Qemu-system Romain Naour
2020-02-09 18:03 ` [Buildroot] [PATCH v4 9/9] gitlab.yml.in*: enable Qemu gitlab testing Romain Naour

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cccdab0a-73d4-3409-275e-a1b8b3422643@smile.fr \
    --to=romain.naour@smile.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.