diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-28 10:16:07 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-12 00:28:14 +0100 |
commit | d552379be3b0240866d1a7d6fe206c0d93aeb43b (patch) | |
tree | a874e83a0df4ccf3d44252621322ca3f1676a58f /documentation | |
parent | 15a41d25e961b4e4becc549cbbb25573c51cadfa (diff) | |
download | poky-d552379be3b0240866d1a7d6fe206c0d93aeb43b.tar.gz |
dev-manual: Moved the "Flashing Images using bmaptool" section.
Fixes [YOCTO #11630]
Moved this section from the "Getting Started with the Yocto
Project" section. The topic is not really a getting started
topic. It is better suited in the "Common Tasks" chapter.
(From yocto-docs rev: d6cdade9066bdbce0596672978c178d2ec82c9a4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 92 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 89 |
2 files changed, 92 insertions, 89 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 71d765089e..0879d0d3e0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -5887,6 +5887,98 @@ | |||
5887 | </para> | 5887 | </para> |
5888 | </section> | 5888 | </section> |
5889 | 5889 | ||
5890 | <section id='flashing-images-using-bmaptool'> | ||
5891 | <title>Flashing Images Using <filename>bmaptool</filename></title> | ||
5892 | |||
5893 | <para> | ||
5894 | An easy way to flash an image to a bootable device is to use | ||
5895 | <filename>bmaptool</filename>, which is integrated into the | ||
5896 | OpenEmbedded build system. | ||
5897 | </para> | ||
5898 | |||
5899 | <para> | ||
5900 | Following, is an example that shows how to flash a Wic image. | ||
5901 | <note> | ||
5902 | You can use <filename>bmaptool</filename> to flash any | ||
5903 | type of image. | ||
5904 | </note> | ||
5905 | Use these steps to flash an image using | ||
5906 | <filename>bmaptool</filename>: | ||
5907 | <note> | ||
5908 | Unless you are able to install the | ||
5909 | <filename>bmap-tools</filename> package as mentioned in the note | ||
5910 | in the second bullet of step 3 further down, you will need to build | ||
5911 | <filename>bmaptool</filename> before using it. | ||
5912 | Build the tool using the following command: | ||
5913 | <literallayout class='monospaced'> | ||
5914 | $ bitbake bmap-tools-native | ||
5915 | </literallayout> | ||
5916 | </note> | ||
5917 | <orderedlist> | ||
5918 | <listitem><para> | ||
5919 | <emphasis>Update the <filename>local.conf</filename> File:</emphasis> | ||
5920 | Add the following to your <filename>local.conf</filename> | ||
5921 | file: | ||
5922 | <literallayout class='monospaced'> | ||
5923 | IMAGE_FSTYPES += "wic wic.bmap" | ||
5924 | </literallayout> | ||
5925 | </para></listitem> | ||
5926 | <listitem><para> | ||
5927 | <emphasis>Get Your Image:</emphasis> | ||
5928 | Either have your image ready (pre-built) or take the step | ||
5929 | build the image: | ||
5930 | <literallayout class='monospaced'> | ||
5931 | $ bitbake <replaceable>image</replaceable> | ||
5932 | </literallayout> | ||
5933 | </para></listitem> | ||
5934 | <listitem><para> | ||
5935 | <emphasis>Flash the Device:</emphasis> | ||
5936 | Flash the device with the image by using | ||
5937 | <filename>bmaptool</filename> depending on your particular | ||
5938 | setup: | ||
5939 | <itemizedlist> | ||
5940 | <listitem><para> | ||
5941 | If you have write access to the media, | ||
5942 | use this command form: | ||
5943 | <literallayout class='monospaced'> | ||
5944 | $ oe-run-native bmaptool-native bmaptool copy ./tmp/deploy/images/qemux86-64-core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable> | ||
5945 | </literallayout> | ||
5946 | </para></listitem> | ||
5947 | <listitem><para> | ||
5948 | If you do not have write access to | ||
5949 | the media, use the following | ||
5950 | commands: | ||
5951 | <literallayout class='monospaced'> | ||
5952 | $ sudo bash | ||
5953 | $ 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> | ||
5954 | </literallayout> | ||
5955 | <note> | ||
5956 | If you are using Ubuntu or Debian distributions, | ||
5957 | you can install the | ||
5958 | <filename>bmap-tools</filename> package using | ||
5959 | the following command and then use the tool | ||
5960 | without specifying | ||
5961 | <filename>PATH</filename> even from the | ||
5962 | root account: | ||
5963 | <literallayout class='monospaced'> | ||
5964 | $ sudo apt-get install bmap-tools | ||
5965 | </literallayout> | ||
5966 | </note> | ||
5967 | </para></listitem> | ||
5968 | </itemizedlist> | ||
5969 | </para></listitem> | ||
5970 | </orderedlist> | ||
5971 | </para> | ||
5972 | |||
5973 | <para> | ||
5974 | For help on the <filename>bmaptool</filename> command, use the | ||
5975 | following command: | ||
5976 | <literallayout class='monospaced'> | ||
5977 | $ bmaptool --help | ||
5978 | </literallayout> | ||
5979 | </para> | ||
5980 | </section> | ||
5981 | |||
5890 | <section id='configuring-the-kernel'> | 5982 | <section id='configuring-the-kernel'> |
5891 | <title>Configuring the Kernel</title> | 5983 | <title>Configuring the Kernel</title> |
5892 | 5984 | ||
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 459254c078..1155d8fc85 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -789,95 +789,6 @@ | |||
789 | </para> | 789 | </para> |
790 | </section> | 790 | </section> |
791 | 791 | ||
792 | <section id='flashing-images-using-bmaptool'> | ||
793 | <title>Flashing Images Using <filename>bmaptool</filename></title> | ||
794 | |||
795 | <para> | ||
796 | An easy way to flash an image to a bootable device is to use | ||
797 | <filename>bmaptool</filename>, which is integrated into the | ||
798 | OpenEmbedded build system. | ||
799 | </para> | ||
800 | |||
801 | <para> | ||
802 | Following, is an example that shows how to flash a Wic image. | ||
803 | <note> | ||
804 | You can use <filename>bmaptool</filename> to flash any | ||
805 | type of image. | ||
806 | </note> | ||
807 | Use these steps to flash an image using | ||
808 | <filename>bmaptool</filename>: | ||
809 | <note> | ||
810 | Unless you are able to install the | ||
811 | <filename>bmap-tools</filename> package as mentioned in the note | ||
812 | in the second bullet of step 3 further down, you will need to build | ||
813 | <filename>bmaptool</filename> before using it. | ||
814 | Build the tool using the following command: | ||
815 | <literallayout class='monospaced'> | ||
816 | $ bitbake bmap-tools-native | ||
817 | </literallayout> | ||
818 | </note> | ||
819 | <orderedlist> | ||
820 | <listitem><para> | ||
821 | Add the following to your <filename>local.conf</filename> | ||
822 | file: | ||
823 | <literallayout class='monospaced'> | ||
824 | IMAGE_FSTYPES += "wic wic.bmap" | ||
825 | </literallayout> | ||
826 | </para></listitem> | ||
827 | <listitem><para> | ||
828 | Either have your image ready (pre-built) or take the step | ||
829 | build the image: | ||
830 | <literallayout class='monospaced'> | ||
831 | $ bitbake <replaceable>image</replaceable> | ||
832 | </literallayout> | ||
833 | </para></listitem> | ||
834 | <listitem><para> | ||
835 | Flash the image to the media by using | ||
836 | <filename>bmaptool</filename> depending on your particular | ||
837 | setup: | ||
838 | <itemizedlist> | ||
839 | <listitem><para> | ||
840 | If you have write access to the media, | ||
841 | use this command form: | ||
842 | <literallayout class='monospaced'> | ||
843 | $ oe-run-native bmaptool-native bmaptool copy ./tmp/deploy/images/qemux86-64-core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable> | ||
844 | </literallayout> | ||
845 | </para></listitem> | ||
846 | <listitem><para> | ||
847 | If you do not have write access to | ||
848 | the media, use the following | ||
849 | commands: | ||
850 | <literallayout class='monospaced'> | ||
851 | $ sudo bash | ||
852 | $ 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> | ||
853 | </literallayout> | ||
854 | <note> | ||
855 | If you are using Ubuntu or Debian distributions, | ||
856 | you can install the | ||
857 | <filename>bmap-tools</filename> package using the | ||
858 | following command and then use the tool | ||
859 | without specifying | ||
860 | <filename>PATH</filename> even from the | ||
861 | root account: | ||
862 | <literallayout class='monospaced'> | ||
863 | $ sudo apt-get install bmap-tools | ||
864 | </literallayout> | ||
865 | </note> | ||
866 | </para></listitem> | ||
867 | </itemizedlist> | ||
868 | </para></listitem> | ||
869 | </orderedlist> | ||
870 | </para> | ||
871 | |||
872 | <para> | ||
873 | For help on the <filename>bmaptool</filename> command, use the | ||
874 | following command: | ||
875 | <literallayout class='monospaced'> | ||
876 | $ bmaptool --help | ||
877 | </literallayout> | ||
878 | </para> | ||
879 | </section> | ||
880 | |||
881 | <section id='using-pre-built-binaries-and-qemu'> | 792 | <section id='using-pre-built-binaries-and-qemu'> |
882 | <title>Using Pre-Built Binaries and QEMU</title> | 793 | <title>Using Pre-Built Binaries and QEMU</title> |
883 | 794 | ||