path: root/documentation/adt-manual
diff options
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-26 16:09:20 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-26 23:30:30 +0100
commit37873380259d39c105d45243e6ce0c88b18a550e (patch)
treed0c94e9a5264c3f2fc2e24e38e05dcf7d3abab00 /documentation/adt-manual
parentd420de6e76ec6ab5c2263ec0ebb4b8c93d46119a (diff)
documentation/adt-manual/adt-eclipse.xml: Added new commander section
Hongna Xu realized that the whole Bitbake Commander part is missing in the ADT manual. This should be Section 4.8. She sent the info and I created a new section titled "Customizing and Image Using a BitBake Commander Project and Hob". Reported-by: Hongna Xu <hongnax.xu@intel.com> (From yocto-docs rev: eb207806dbd2f73089068ef9e3fa447aa8a38404) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual')
1 files changed, 87 insertions, 0 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index dcc201cdc8..3a6dce5da7 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -643,6 +643,93 @@
+<section id='customizing-an-image-using-a-bitbake-commander-project-and-hob'>
+ <title>Customizing an Image Using a BitBake Commander Project and Hob</title>
+ <para>
+ Within Eclipse, you can create a Yocto BitBake Commander project,
+ edit the metadata, and then use the
+ <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build a customized
+ image all within one IDE.
+ </para>
+ <section id='creating-the-yocto-bitbake-commander-project'>
+ <title>Creating the Yocto BitBake Commander Project</title>
+ <para>
+ To create a Yocto BitBake Commander project, follow these steps:
+ <orderedlist>
+ <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
+ and then choose <filename>Bitbake Commander</filename>.</para></listitem>
+ <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective into the
+ Bitbake Commander perspective.</para></listitem>
+ <listitem><para>Select <filename>File -> New -> Project</filename> to create a new Yocto
+ Bitbake Commander project.</para></listitem>
+ <listitem><para>Choose <filename>Yocto Project Bitbake Commander -> New Yocto Project</filename>
+ and click <filename>Next</filename>.</para></listitem>
+ <listitem><para>Enter the Project Name and choose the Project Location.
+ The Yocto project's metadata files will be put under the directory
+ <filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>.
+ If that directory does not exist, you need to check
+ the "Clone from Yocto Git Repository" box, which would execute a
+ <filename>git clone</filename> command to get the Yocto project's metadata files.
+ </para></listitem>
+ <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem>
+ </orderedlist>
+ </para>
+ </section>
+ <section id='editing-the-metadata-files'>
+ <title>Editing the Metadata Files</title>
+ <para>
+ After you create the Yocto Bitbake Commander project, you can modify the metadata files
+ by opening them in the project.
+ When editing recipe files (<filename>.bb</filename> files), you can view BitBake
+ variable values and information by hovering the mouse pointer over the variable name and
+ waiting a few seconds.
+ </para>
+ <para>
+ To edit the metadata, follow these steps:
+ <orderedlist>
+ <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
+ <listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename>
+ to open a new recipe wizard.</para></listitem>
+ <listitem><para>Point to your source by filling in the "SRC_URL" field.
+ For example, you can add a recipe in the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>Yocto Project Source Files</ulink>,
+ input the "SRC_URL" as follows:
+ <literallayout class='monospaced'>
+ ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
+ </literallayout></para></listitem>
+ <listitem><para>Click "Populate" to calculate the archive md5, sha256,
+ license checksum values and to auto-generate the recipe filename.</para></listitem>
+ <listitem><para>Fill in the "Description" field.</para></listitem>
+ <listitem><para>Be sure values for all required fields exist.</para></listitem>
+ <listitem><para>Click <filename>Finish</filename>.</para></listitem>
+ </orderedlist>
+ </para>
+ </section>
+ <section id='buiding-and-customizing-the-image'>
+ <title>Building and Customizing the Image</title>
+ <para>
+ To build and customize the image in Eclipse, follow these steps:
+ <orderedlist>
+ <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
+ <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem>
+ <listitem><para>Enter the build directory where you want to put your final images.</para></listitem>
+ <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem>
+ <listitem><para>Use Hob to customize and build your own images.
+ For information on Hob, see the
+ <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob Project Page</ulink> on the
+ Yocto Project website.</para></listitem>
+ </orderedlist>
+ </para>
+ </section>
vim: expandtab tw=80 ts=4