[Buildroot] [PATCH 9/9] manual: rework Deploying images chapter

[Thomas De Schampheleire]

Hi Samuel, Arnout,

On Tue, Oct 8, 2013 at 10:29 PM, Arnout Vandecappelle <arnout at mind.be> wrote:
> On 10/05/13 21:49, Samuel Martin wrote:
>>
[..]
>> +flashing and/or booting the given platform.
>> +
>> +Although, deploying the generated images on the actual hardware
>> +(flashing and booting the hardware) is very tight to the target
>> +hardware and can differ a lot from one target to another.
>> +Buildroot cannot provide information on this part.
>> +
>> +For deploying images on the actual target, refer to the hardware
>> +vendor instructions, or the readme file in the _board_ directory if
>> +any.
>
>
>  I don't like how these two paragraphs are formulated, but I can't readily
> think of an improvement.
>

Maybe:
Nevertheless, how to deploy the generated images on actual hardware is
very board-specific. Buildroot cannot provide instructions for all
boards, or even provide complete instructions for a single board.
Please refer to the instructions provided by the target vendor.

[..]



Regarding the section names, currently you have:
4. Deploying target images built with Buildroot
4.1. Deploying images on the target hardware
4.2. Booting images in emulators
4.3. Preparing a raw disk image for customized target layout
4.4. Preparing a bootable raw disk file for virtualization
4.5. Booting the generated image over the network
4.6. Chroot into generated image

While 4 and 4.1 talk about 'deploying' the other sections start using
other terminology. Here is a suggestion:
4. Deploying target images built with Buildroot
4.1. Deploying images on the target hardware
4.2. Deploying images in emulators
4.3. Preparing a raw disk image for customized target layout
4.4. Preparing a bootable raw disk file for virtualization
4.5. Deploying images over the network
4.6. Chroot into generated image

In fact, 4.5 also talks about target hardware, so should probably be
moved above, or even a subsection of 4.1.
I'm not yet a big fan of the names of 4.3, 4.4 and 4.6 (it's unclear
to me what they really do based on the title) but I don't have good
suggestions.

Best regards,
Thomas