summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml29
-rw-r--r--documentation/dev-manual/dev-manual-start.xml93
2 files changed, 118 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index b2a2e32c5d..95289c990f 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4823,10 +4823,14 @@
4823 </para> 4823 </para>
4824 4824
4825 <para> 4825 <para>
4826 Continuing with the example, you can now directly 4826 Continuing with the example, you can now write the
4827 <filename>dd</filename> the image to a USB stick, or 4827 image to a USB stick, or whatever media for which
4828 whatever media for which you built your image, 4828 you built your image, and boot the resulting media.
4829 and boot the resulting media: 4829 </para>
4830
4831 <para>
4832 The following example uses <filename>dd</filename>
4833 to write the image to a USB stick:
4830 <literallayout class='monospaced'> 4834 <literallayout class='monospaced'>
4831 $ sudo dd if=/var/tmp/wic/build/mkefidisk-201310230946-sda.direct of=/dev/sdb 4835 $ sudo dd if=/var/tmp/wic/build/mkefidisk-201310230946-sda.direct of=/dev/sdb
4832 [sudo] password for trz: 4836 [sudo] password for trz:
@@ -4836,6 +4840,23 @@
4836 [trz at empanada ~]$ sudo eject /dev/sdb 4840 [trz at empanada ~]$ sudo eject /dev/sdb
4837 </literallayout> 4841 </literallayout>
4838 </para> 4842 </para>
4843
4844 <para>
4845 This next example uses the
4846 <filename>bmap-tool</filename>.
4847 For this example, it is assumed you have write
4848 access:
4849 <literallayout class='monospaced'>
4850 $ oe-run-native bmap-tool copy /home/trz/yocto/yocto-image/scripts/lib/image/canned-wks/mkefidisk.wks /dev/sdb
4851 </literallayout>
4852 <note>
4853 For more information on how to use the
4854 <filename>bmap-tool</filename> to flash a device
4855 with an image, see the
4856 "<link linkend='flashing-images-using-bmap-tool'>Flashing Images Using <filename>bmap-tool</filename></link>"
4857 section.
4858 </note>
4859 </para>
4839 </section> 4860 </section>
4840 4861
4841 <section id='using-a-modified-kickstart-file'> 4862 <section id='using-a-modified-kickstart-file'>
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index b59f54b085..bcee11ba22 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -328,6 +328,99 @@
328 </para> 328 </para>
329</section> 329</section>
330 330
331<section id='flashing-images-using-bmap-tool'>
332 <title>Flashing Images Using <filename>bmap-tool</filename></title>
333
334 <para>
335 An easy way to flash an image to a bootable device is to use
336 <filename>bmap-tool</filename>, which is integrated into the
337 OpenEmbedded build system.
338 </para>
339
340 <para>
341 Following, is an example that shows how to flash a Wic image.
342 <note>
343 You can use <filename>bmap-tool</filename> to flash any
344 type of image.
345 </note>
346 Use these steps to flash an image using
347 <filename>bmap-tool</filename>:
348 <orderedlist>
349 <listitem><para>
350 Add the following to your <filename>local.conf</filename>
351 file:
352 <literallayout class='monospaced'>
353 IMAGE_FSTYPES += "WIC WIC.BMAP"
354 </literallayout>
355 </para></listitem>
356 <listitem><para>
357 Either have your image ready (pre-built) or take the step
358 build the image:
359 <literallayout class='monospaced'>
360 $ bitbake <replaceable>image</replaceable>
361 </literallayout>
362 </para></listitem>
363 <listitem><para>
364 Flash the image to the media by using the
365 <filename>bmap-tool</filename> depending on your particular
366 setup:
367 <itemizedlist>
368 <listitem><para>
369 If you have write access, use this command form:
370 <literallayout class='monospaced'>
371 $ oe-run-native bmap-tool copy ./tmp/deploy/images/qemux86-64/core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
372 </literallayout>
373 </para></listitem>
374 <listitem><para>
375 If you do not have write access, use the following
376 commands:
377 <literallayout class='monospaced'>
378 $ sudo bash
379 $ PATH=tmp/sysroots/x86_64-linux/usr/bin/ bmaptool copy ./tmp/deploy/images/qemux86-64/core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
380 </literallayout>
381 <note>
382 If you are using Ubuntu 16.10 or Debian,
383 you can install
384 <filename>bmaptool</filename> using the
385 following command and then use the tool
386 without specifying
387 <filename>PATH</filename> even from the
388 root account:
389 <literallayout class='monospaced'>
390 $ sudo apt-get install bmap-tool
391 </literallayout>
392 </note>
393 </para></listitem>
394 </itemizedlist>
395 </para></listitem>
396 </orderedlist>
397 </para>
398
399 <para>
400 For help on the <filename>bmaptool</filename> command, use
401 <filename>bmaptool --help</filename>:
402 <literallayout class='monospaced'>
403 $ bmaptool --help
404 usage: bmaptool [-h] [--version] [-q] [-d] {create,copy} ...
405
406 Create block map (bmap) and copy files using bmap. The documentation can be
407 found here: source.tizen.org/documentation/reference/bmaptool
408
409 optional arguments:
410 -h, --help show this help message and exit
411 --version show program's version number and exit
412 -q, --quiet be quiet
413 -d, --debug print debugging information
414
415 subcommands:
416 {create,copy}
417 create generate bmap for an image file (which should be a sparse
418 file)
419 copy write an image to a block device using bmap
420 </literallayout>
421 </para>
422</section>
423
331<section id='using-pre-built-binaries-and-qemu'> 424<section id='using-pre-built-binaries-and-qemu'>
332 <title>Using Pre-Built Binaries and QEMU</title> 425 <title>Using Pre-Built Binaries and QEMU</title>
333 426