summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-eclipse.xml87
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 @@
643 </para> 643 </para>
644</section> 644</section>
645 645
646<section id='customizing-an-image-using-a-bitbake-commander-project-and-hob'>
647 <title>Customizing an Image Using a BitBake Commander Project and Hob</title>
648
649 <para>
650 Within Eclipse, you can create a Yocto BitBake Commander project,
651 edit the metadata, and then use the
652 <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build a customized
653 image all within one IDE.
654 </para>
655
656 <section id='creating-the-yocto-bitbake-commander-project'>
657 <title>Creating the Yocto BitBake Commander Project</title>
658
659 <para>
660 To create a Yocto BitBake Commander project, follow these steps:
661 <orderedlist>
662 <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
663 and then choose <filename>Bitbake Commander</filename>.</para></listitem>
664 <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective into the
665 Bitbake Commander perspective.</para></listitem>
666 <listitem><para>Select <filename>File -> New -> Project</filename> to create a new Yocto
667 Bitbake Commander project.</para></listitem>
668 <listitem><para>Choose <filename>Yocto Project Bitbake Commander -> New Yocto Project</filename>
669 and click <filename>Next</filename>.</para></listitem>
670 <listitem><para>Enter the Project Name and choose the Project Location.
671 The Yocto project's metadata files will be put under the directory
672 <filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>.
673 If that directory does not exist, you need to check
674 the "Clone from Yocto Git Repository" box, which would execute a
675 <filename>git clone</filename> command to get the Yocto project's metadata files.
676 </para></listitem>
677 <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem>
678 </orderedlist>
679 </para>
680 </section>
681
682 <section id='editing-the-metadata-files'>
683 <title>Editing the Metadata Files</title>
684
685 <para>
686 After you create the Yocto Bitbake Commander project, you can modify the metadata files
687 by opening them in the project.
688 When editing recipe files (<filename>.bb</filename> files), you can view BitBake
689 variable values and information by hovering the mouse pointer over the variable name and
690 waiting a few seconds.
691 </para>
692
693 <para>
694 To edit the metadata, follow these steps:
695 <orderedlist>
696 <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
697 <listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename>
698 to open a new recipe wizard.</para></listitem>
699 <listitem><para>Point to your source by filling in the "SRC_URL" field.
700 For example, you can add a recipe in the
701 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>Yocto Project Source Files</ulink>,
702 input the "SRC_URL" as follows:
703 <literallayout class='monospaced'>
704 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
705 </literallayout></para></listitem>
706 <listitem><para>Click "Populate" to calculate the archive md5, sha256,
707 license checksum values and to auto-generate the recipe filename.</para></listitem>
708 <listitem><para>Fill in the "Description" field.</para></listitem>
709 <listitem><para>Be sure values for all required fields exist.</para></listitem>
710 <listitem><para>Click <filename>Finish</filename>.</para></listitem>
711 </orderedlist>
712 </para>
713 </section>
714
715 <section id='buiding-and-customizing-the-image'>
716 <title>Building and Customizing the Image</title>
717
718 <para>
719 To build and customize the image in Eclipse, follow these steps:
720 <orderedlist>
721 <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
722 <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem>
723 <listitem><para>Enter the build directory where you want to put your final images.</para></listitem>
724 <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem>
725 <listitem><para>Use Hob to customize and build your own images.
726 For information on Hob, see the
727 <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob Project Page</ulink> on the
728 Yocto Project website.</para></listitem>
729 </orderedlist>
730 </para>
731 </section>
732</section>
646</chapter> 733</chapter>
647<!-- 734<!--
648vim: expandtab tw=80 ts=4 735vim: expandtab tw=80 ts=4