diff options
Diffstat (limited to 'documentation/sdk-manual/sdk-using.xml')
-rw-r--r-- | documentation/sdk-manual/sdk-using.xml | 713 |
1 files changed, 420 insertions, 293 deletions
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml index 70c1bf5c77..6b14f1b575 100644 --- a/documentation/sdk-manual/sdk-using.xml +++ b/documentation/sdk-manual/sdk-using.xml | |||
@@ -558,7 +558,7 @@ | |||
558 | Once your application is deployed, you need to test it. | 558 | Once your application is deployed, you need to test it. |
559 | Within the Eclipse IDE, you can use the debugging | 559 | Within the Eclipse IDE, you can use the debugging |
560 | environment along with supported performance enhancing | 560 | environment along with supported performance enhancing |
561 | <ulink url='http://www.eclipse.org/linuxtools/'>tools</ulink>. | 561 | <ulink url='http://www.eclipse.org/linuxtools/'>Linux Tools</ulink>. |
562 | </para></listitem> | 562 | </para></listitem> |
563 | </orderedlist> | 563 | </orderedlist> |
564 | </para> | 564 | </para> |
@@ -567,20 +567,9 @@ | |||
567 | <section id='adt-eclipse'> | 567 | <section id='adt-eclipse'> |
568 | <title>Working Within Eclipse</title> | 568 | <title>Working Within Eclipse</title> |
569 | 569 | ||
570 | <para role="writernotes"> | ||
571 | This section needs to be updated to use Eclipse Neon throughout. | ||
572 | It is out of date at the moment. | ||
573 | </para> | ||
574 | |||
575 | <para> | 570 | <para> |
576 | The Eclipse IDE is a popular development environment and it fully | 571 | The Eclipse IDE is a popular development environment and it fully |
577 | supports development using the Yocto Project. | 572 | supports development using the Yocto Project. |
578 | <note> | ||
579 | This release of the Yocto Project supports both the Luna | ||
580 | and Kepler versions of the Eclipse IDE. | ||
581 | Thus, the following information provides setup information for | ||
582 | both versions. | ||
583 | </note> | ||
584 | </para> | 573 | </para> |
585 | 574 | ||
586 | <para> | 575 | <para> |
@@ -598,27 +587,31 @@ | |||
598 | allow you to perform remote profiling, tracing, collection of | 587 | allow you to perform remote profiling, tracing, collection of |
599 | power data, collection of latency data, and collection of | 588 | power data, collection of latency data, and collection of |
600 | performance data. | 589 | performance data. |
590 | <note> | ||
591 | This release of the Yocto Project supports both the Neon | ||
592 | and Mars versions of the Eclipse IDE. | ||
593 | This section provides information on how to use the Neon | ||
594 | release with the Yocto Project. | ||
595 | For information on how to use the Mars version of Eclipse | ||
596 | with the Yocto Project, see | ||
597 | "<link linkend='sdk-appendix-mars'>Appendix C</link>. | ||
598 | </note> | ||
601 | </para> | 599 | </para> |
602 | 600 | ||
603 | <para> | 601 | <section id='neon-setting-up-the-eclipse-ide'> |
604 | This section describes how to install and configure the Eclipse IDE | 602 | <title>Setting Up the Neon Version of the Eclipse IDE</title> |
605 | Yocto Plug-in and how to use it to develop your application. | ||
606 | </para> | ||
607 | |||
608 | <section id='setting-up-the-eclipse-ide'> | ||
609 | <title>Setting Up the Eclipse IDE</title> | ||
610 | 603 | ||
611 | <para> | 604 | <para> |
612 | To develop within the Eclipse IDE, you need to do the following: | 605 | To develop within the Eclipse IDE, you need to do the following: |
613 | <orderedlist> | 606 | <orderedlist> |
614 | <listitem><para>Install the optimal version of the Eclipse | 607 | <listitem><para>Install the Neon version of the Eclipse |
615 | IDE.</para></listitem> | 608 | IDE.</para></listitem> |
616 | <listitem><para>Configure the Eclipse IDE. | 609 | <listitem><para>Configure the Eclipse IDE. |
617 | </para></listitem> | 610 | </para></listitem> |
618 | <listitem><para>Install the Eclipse Yocto Plug-in. | 611 | <listitem><para>Install the Eclipse Yocto Plug-in. |
619 | </para></listitem> | 612 | </para></listitem> |
620 | <listitem><para>Configure the Eclipse Yocto Plug-in. | 613 | <listitem><para>Configure the Eclipse Yocto Plug-in. |
621 | </para></listitem> | 614 | </para></listitem> |
622 | </orderedlist> | 615 | </orderedlist> |
623 | <note> | 616 | <note> |
624 | Do not install Eclipse from your distribution's package | 617 | Do not install Eclipse from your distribution's package |
@@ -628,110 +621,120 @@ | |||
628 | </note> | 621 | </note> |
629 | </para> | 622 | </para> |
630 | 623 | ||
631 | <section id='installing-eclipse-ide'> | 624 | <section id='neon-installing-eclipse-ide'> |
632 | <title>Installing the Eclipse IDE</title> | 625 | <title>Installing the Neon Eclipse IDE</title> |
633 | |||
634 | <para> | ||
635 | It is recommended that you have the Luna SR2 (4.4.2) | ||
636 | version of the Eclipse IDE installed on your development | ||
637 | system. | ||
638 | However, if you currently have the Kepler 4.3.2 version | ||
639 | installed and you do not want to upgrade the IDE, you can | ||
640 | configure Kepler to work with the Yocto Project. | ||
641 | </para> | ||
642 | 626 | ||
643 | <para> | 627 | <para> |
644 | If you do not have the Luna SR2 (4.4.2) Eclipse IDE | 628 | Follow these steps to locate, install, and configure |
645 | installed, you can find the tarball at | 629 | Neon Eclipse: |
646 | <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. | 630 | <orderedlist> |
647 | From that site, choose the appropriate download from the | 631 | <listitem><para> |
648 | "Eclipse IDE for C/C++ Developers". | 632 | <emphasis>Locate the Neon Download:</emphasis> |
649 | This version contains the Eclipse Platform, the Java | 633 | Open a browser and go to |
650 | Development Tools (JDT), and the Plug-in Development | 634 | <ulink url='http://www.eclipse.org/mars/'>http://www.eclipse.org/neon/</ulink>. |
651 | Environment. | 635 | </para></listitem> |
652 | </para> | 636 | <listitem><para> |
653 | 637 | <emphasis>Download the Tarball:</emphasis> | |
654 | <para> | 638 | Click through the "Download" buttons to |
655 | Once you have downloaded the tarball, extract it into a | 639 | download the file. |
656 | clean directory. | 640 | </para></listitem> |
657 | For example, the following commands unpack and install the | 641 | <listitem><para> |
658 | downloaded Eclipse IDE tarball into a clean directory | 642 | <emphasis>Unpack the Tarball:</emphasis> |
659 | using the default name <filename>eclipse</filename>: | 643 | Move to a clean directory and unpack the tarball. |
660 | <literallayout class='monospaced'> | 644 | Here is an example: |
645 | <literallayout class='monospaced'> | ||
661 | $ cd ~ | 646 | $ cd ~ |
662 | $ tar -xzvf ~/Downloads/eclipse-cpp-luna-SR2-linux-gtk-x86_64.tar.gz | 647 | $ tar -xzvf ~/Downloads/eclipse-inst-linux64.tar.gz |
663 | </literallayout> | 648 | </literallayout> |
649 | Everything unpacks into a folder named | ||
650 | "eclipse-installer". | ||
651 | </para></listitem> | ||
652 | <listitem><para> | ||
653 | <emphasis>Launch the Installer:</emphasis> | ||
654 | Use the following commands to launch the installer: | ||
655 | <literallayout class='monospaced'> | ||
656 | $ cd ~/eclipse-installer | ||
657 | $ ./eclipse-inst | ||
658 | </literallayout> | ||
659 | </para></listitem> | ||
660 | <listitem><para> | ||
661 | <emphasis>Select Your IDE:</emphasis> | ||
662 | From the list, select the "Eclipse IDE for | ||
663 | C/C++ Developers". | ||
664 | </para></listitem> | ||
665 | <listitem><para> | ||
666 | <emphasis>Install the Software:</emphasis> | ||
667 | Accept the default "cpp-neon" directory and click | ||
668 | "Install". | ||
669 | Accept any license agreements and approve any | ||
670 | certificates. | ||
671 | </para></listitem> | ||
672 | <listitem><para> | ||
673 | <emphasis>Launch Neon:</emphasis> | ||
674 | Click the "Launch" button and accept the default | ||
675 | "workspace". | ||
676 | </para></listitem> | ||
677 | </orderedlist> | ||
664 | </para> | 678 | </para> |
665 | </section> | 679 | </section> |
666 | 680 | ||
667 | <section id='configuring-the-eclipse-ide'> | 681 | <section id='neon-configuring-the-mars-eclipse-ide'> |
668 | <title>Configuring the Eclipse IDE</title> | 682 | <title>Configuring the Neon Eclipse IDE</title> |
669 | |||
670 | <para> | ||
671 | This section presents the steps needed to configure the | ||
672 | Eclipse IDE. | ||
673 | </para> | ||
674 | 683 | ||
675 | <para> | 684 | <para> |
676 | Before installing and configuring the Eclipse Yocto Plug-in, | 685 | Follow these steps to configure the Neon Eclipse IDE. |
677 | you need to configure the Eclipse IDE. | 686 | <note> |
678 | Follow these general steps: | 687 | Depending on how you installed Eclipse and what you have |
688 | already done, some of the options will not appear. | ||
689 | If you cannot find an option as directed by the manual, | ||
690 | it has already been installed. | ||
691 | </note> | ||
679 | <orderedlist> | 692 | <orderedlist> |
680 | <listitem><para>Start the Eclipse IDE.</para></listitem> | 693 | <listitem><para>Be sure Eclipse is running and |
681 | <listitem><para>Make sure you are in your Workbench and | 694 | you are in your workbench. |
682 | select "Install New Software" from the "Help" | 695 | </para></listitem> |
683 | pull-down menu.</para></listitem> | 696 | <listitem><para>Select "Install New Software" from |
697 | the "Help" pull-down menu. | ||
698 | </para></listitem> | ||
684 | <listitem><para>Select | 699 | <listitem><para>Select |
685 | <filename>Luna - &ECLIPSE_LUNA_URL;</filename> | 700 | "Neon - http://download.eclipse.org/releases/neon" |
686 | from the "Work with:" pull-down menu. | 701 | from the "Work with:" pull-down menu. |
687 | <note> | ||
688 | For Kepler, select | ||
689 | <filename>Kepler - &ECLIPSE_KEPLER_URL;</filename> | ||
690 | </note> | ||
691 | </para></listitem> | 702 | </para></listitem> |
692 | <listitem><para>Expand the box next to "Linux Tools" | 703 | <listitem><para>Expand the box next to |
693 | and select the | 704 | "Linux Tools" and select the following: |
694 | <filename>Linux Tools LTTng Tracer Control</filename>, | 705 | <literallayout class='monospaced'> |
695 | <filename>Linux Tools LTTng Userspace Analysis</filename>, | 706 | C/C++ Remote (Over TCF/TE) Run/Debug Launcher |
696 | and | 707 | TM Terminal |
697 | <filename>LTTng Kernel Analysis</filename> boxes. | 708 | </literallayout> |
698 | If these selections do not appear in the list, | ||
699 | that means the items are already installed. | ||
700 | <note> | ||
701 | For Kepler, select | ||
702 | <filename>LTTng - Linux Tracing Toolkit</filename> | ||
703 | box. | ||
704 | </note> | ||
705 | </para></listitem> | 709 | </para></listitem> |
706 | <listitem><para>Expand the box next to "Mobile and | 710 | <listitem><para>Expand the box next to "Mobile and |
707 | Device Development" and select the following boxes. | 711 | Device Development" and select the following |
708 | Again, if any of the following items are not | 712 | boxes: |
709 | available for selection, that means the items are | 713 | <literallayout class='monospaced'> |
710 | already installed: | 714 | C/C++ Remote (Over TCF/TE) Run/Debug Launcher |
711 | <itemizedlist> | 715 | Remote System Explorer User Actions |
712 | <listitem><para><filename>C/C++ Remote Launch (Requires RSE Remote System Explorer)</filename></para></listitem> | 716 | TM Terminal |
713 | <listitem><para><filename>Remote System Explorer End-user Runtime</filename></para></listitem> | 717 | TCF Remote System Explorer add-in |
714 | <listitem><para><filename>Remote System Explorer User Actions</filename></para></listitem> | 718 | TCF Target Explorer |
715 | <listitem><para><filename>Target Management Terminal (Core SDK)</filename></para></listitem> | 719 | </literallayout> |
716 | <listitem><para><filename>TCF Remote System Explorer add-in</filename></para></listitem> | 720 | </para></listitem> |
717 | <listitem><para><filename>TCF Target Explorer</filename></para></listitem> | 721 | <listitem><para>Expand the box next to |
718 | </itemizedlist></para></listitem> | 722 | "Programming Languages" and select the |
719 | <listitem><para>Expand the box next to "Programming | 723 | following box: |
720 | Languages" and select the | 724 | <literallayout class='monospaced'> |
721 | <filename>C/C++ Autotools Support</filename> | 725 | C/C++ Development Tools SDK |
722 | and <filename>C/C++ Development Tools</filename> | 726 | </literallayout> |
723 | boxes. | 727 | </para></listitem> |
724 | For Luna, these items do not appear on the list | 728 | <listitem><para> |
725 | as they are already installed. | 729 | Complete the installation by clicking through |
730 | appropriate "Next" and "Finish" buttons. | ||
726 | </para></listitem> | 731 | </para></listitem> |
727 | <listitem><para>Complete the installation and restart | ||
728 | the Eclipse IDE.</para></listitem> | ||
729 | </orderedlist> | 732 | </orderedlist> |
730 | </para> | 733 | </para> |
731 | </section> | 734 | </section> |
732 | 735 | ||
733 | <section id='installing-the-eclipse-yocto-plug-in'> | 736 | <section id='neon-installing-the-eclipse-yocto-plug-in'> |
734 | <title>Installing or Accessing the Eclipse Yocto Plug-in</title> | 737 | <title>Installing or Accessing the Neon Eclipse Yocto Plug-in</title> |
735 | 738 | ||
736 | <para> | 739 | <para> |
737 | You can install the Eclipse Yocto Plug-in into the Eclipse | 740 | You can install the Eclipse Yocto Plug-in into the Eclipse |
@@ -740,12 +743,12 @@ | |||
740 | install the plug-in from the latest source code. | 743 | install the plug-in from the latest source code. |
741 | </para> | 744 | </para> |
742 | 745 | ||
743 | <section id='new-software'> | 746 | <section id='neon-new-software'> |
744 | <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title> | 747 | <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title> |
745 | 748 | ||
746 | <para> | 749 | <para> |
747 | To install the Eclipse Yocto Plug-in from the update | 750 | To install the Neon Eclipse Yocto Plug-in from the |
748 | site, follow these steps: | 751 | update site, follow these steps: |
749 | <orderedlist> | 752 | <orderedlist> |
750 | <listitem><para>Start up the Eclipse IDE. | 753 | <listitem><para>Start up the Eclipse IDE. |
751 | </para></listitem> | 754 | </para></listitem> |
@@ -753,27 +756,24 @@ | |||
753 | Software" from the "Help" menu. | 756 | Software" from the "Help" menu. |
754 | </para></listitem> | 757 | </para></listitem> |
755 | <listitem><para>Click "Add..." in the "Work with:" | 758 | <listitem><para>Click "Add..." in the "Work with:" |
756 | area.</para></listitem> | 759 | area. |
757 | <listitem><para>Enter | 760 | </para></listitem> |
758 | <filename>&ECLIPSE_DL_PLUGIN_URL;/luna</filename> | 761 | <listitem><para>Enter |
762 | <filename>&ECLIPSE_DL_PLUGIN_URL;/neon</filename> | ||
759 | in the URL field and provide a meaningful name | 763 | in the URL field and provide a meaningful name |
760 | in the "Name" field. | 764 | in the "Name" field. |
761 | <note> | 765 | </para></listitem> |
762 | If you are using Kepler, use | ||
763 | <filename>&ECLIPSE_DL_PLUGIN_URL;/kepler</filename> | ||
764 | in the URL field. | ||
765 | </note></para></listitem> | ||
766 | <listitem><para>Click "OK" to have the entry added | 766 | <listitem><para>Click "OK" to have the entry added |
767 | to the "Work with:" drop-down list. | 767 | to the "Work with:" drop-down list. |
768 | </para></listitem> | 768 | </para></listitem> |
769 | <listitem><para>Select the entry for the plug-in | 769 | <listitem><para>Select the entry for the plug-in |
770 | from the "Work with:" drop-down list. | 770 | from the "Work with:" drop-down list. |
771 | </para></listitem> | 771 | </para></listitem> |
772 | <listitem><para>Check the boxes next to | 772 | <listitem><para>Check the boxes next to the following: |
773 | <filename>Yocto Project ADT Plug-in</filename>, | 773 | <literallayout class='monospaced'> |
774 | <filename>Yocto Project Bitbake Commander Plug-in</filename>, | 774 | Yocto Project SDK Plug-in |
775 | and | 775 | Yocto Project Documentation plug-in |
776 | <filename>Yocto Project Documentation plug-in</filename>. | 776 | </literallayout> |
777 | </para></listitem> | 777 | </para></listitem> |
778 | <listitem><para>Complete the remaining software | 778 | <listitem><para>Complete the remaining software |
779 | installation steps and then restart the Eclipse | 779 | installation steps and then restart the Eclipse |
@@ -788,61 +788,55 @@ | |||
788 | </para> | 788 | </para> |
789 | </section> | 789 | </section> |
790 | 790 | ||
791 | <section id='zip-file-method'> | 791 | <section id='neon-zip-file-method'> |
792 | <title>Installing the Plug-in Using the Latest Source Code</title> | 792 | <title>Installing the Plug-in Using the Latest Source Code</title> |
793 | 793 | ||
794 | <para> | 794 | <para> |
795 | To install the Eclipse Yocto Plug-in from the latest | 795 | To install the Neon Eclipse Yocto Plug-in from the |
796 | source code, follow these steps: | 796 | latest source code, follow these steps: |
797 | <orderedlist> | 797 | <orderedlist> |
798 | <listitem><para>Be sure your development system | 798 | <listitem><para>Be sure your development system |
799 | is not using OpenJDK to build the plug-in | 799 | has JDK 1.7+ |
800 | by doing the following: | ||
801 | <orderedlist> | ||
802 | <listitem><para>Use the Oracle JDK. | ||
803 | If you don't have that, go to | ||
804 | <ulink url='http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html'></ulink> | ||
805 | and download the latest appropriate | ||
806 | Java SE Development Kit tarball for | ||
807 | your development system and | ||
808 | extract it into your home directory. | ||
809 | </para></listitem> | ||
810 | <listitem><para>In the shell you are going | ||
811 | to do your work, export the location of | ||
812 | the Oracle Java. | ||
813 | The previous step creates a new folder | ||
814 | for the extracted software. | ||
815 | You need to use the following | ||
816 | <filename>export</filename> command | ||
817 | and provide the specific location: | ||
818 | <literallayout class='monospaced'> | ||
819 | export PATH=~/<replaceable>extracted_jdk_location</replaceable>/bin:$PATH | ||
820 | </literallayout> | ||
821 | </para></listitem> | ||
822 | </orderedlist> | ||
823 | </para></listitem> | 800 | </para></listitem> |
824 | <listitem><para>In the same shell, create a Git | 801 | <listitem><para>install X11-related packages: |
825 | repository with: | 802 | <literallayout class='monospaced'> |
803 | $ sudo apt-get install xauth | ||
804 | </literallayout> | ||
805 | </para></listitem> | ||
806 | <listitem><para>In a new terminal shell, create a | ||
807 | Git repository with: | ||
826 | <literallayout class='monospaced'> | 808 | <literallayout class='monospaced'> |
827 | $ cd ~ | 809 | $ cd ~ |
828 | $ git clone git://git.yoctoproject.org/eclipse-poky | 810 | $ git clone git://git.yoctoproject.org/eclipse-poky |
829 | </literallayout> | 811 | </literallayout> |
830 | </para></listitem> | 812 | </para></listitem> |
831 | <listitem><para>Be sure to checkout the correct | 813 | <listitem><para>Use Git to create the correct |
832 | tag. | 814 | tag: |
833 | For example, if you are using Luna, do the | 815 | |
834 | following: | 816 | <note><title>Developer's Note</title> |
817 | <para role='writernotes'> | ||
818 | Because the 2.2 tag will not exist until after | ||
819 | the release, I must first do the following | ||
820 | before running the | ||
821 | <filename>git checkout mars/yocto-&DISTRO;</filename> | ||
822 | command in this step: | ||
823 | <literallayout class='monospaced'> | ||
824 | $ cd ~/eclipse-poky | ||
825 | $ git tag neon/yocto-2.2 origin/neon-master | ||
826 | </literallayout></para> | ||
827 | </note> | ||
828 | |||
835 | <literallayout class='monospaced'> | 829 | <literallayout class='monospaced'> |
836 | $ git checkout luna/yocto-&DISTRO; | 830 | $ cd ~/eclipse-poky |
831 | $ git checkout neon/yocto-&DISTRO; | ||
837 | </literallayout> | 832 | </literallayout> |
838 | This puts you in a detached HEAD state, which | 833 | This creates a local tag named |
834 | <filename>neon/yocto-&DISTRO;</filename> | ||
835 | based on the branch | ||
836 | <filename>origin/neon-master</filename>. | ||
837 | You are put into a detached HEAD state, which | ||
839 | is fine since you are only going to be building | 838 | is fine since you are only going to be building |
840 | and not developing. | 839 | and not developing. |
841 | <note> | ||
842 | If you are building kepler, checkout the | ||
843 | <filename>kepler/yocto-&DISTRO;</filename> | ||
844 | branch. | ||
845 | </note> | ||
846 | </para></listitem> | 840 | </para></listitem> |
847 | <listitem><para>Change to the | 841 | <listitem><para>Change to the |
848 | <filename>scripts</filename> | 842 | <filename>scripts</filename> |
@@ -856,27 +850,29 @@ | |||
856 | <literallayout class='monospaced'> | 850 | <literallayout class='monospaced'> |
857 | $ ./setup.sh | 851 | $ ./setup.sh |
858 | </literallayout> | 852 | </literallayout> |
859 | </para></listitem> | 853 | When the script finishes execution, |
860 | <listitem><para>When the script finishes execution, | ||
861 | it prompts you with instructions on how to run | 854 | it prompts you with instructions on how to run |
862 | the <filename>build.sh</filename> script, which | 855 | the <filename>build.sh</filename> script, which |
863 | is also in the <filename>scripts</filename> | 856 | is also in the <filename>scripts</filename> |
864 | directory of the Git repository created | 857 | directory of the Git repository created |
865 | earlier. | 858 | earlier. |
866 | </para></listitem> | 859 | </para></listitem> |
867 | <listitem><para>Run the <filename>build.sh</filename> | 860 | <listitem><para> |
861 | Run the <filename>build.sh</filename> | ||
868 | script as directed. | 862 | script as directed. |
869 | Be sure to provide the tag name, documentation | 863 | Be sure to provide the tag name, documentation |
870 | branch, and a release name. | 864 | branch, and a release name.</para> |
871 | Here is an example that uses the | 865 | <para> |
872 | <filename>luna/yocto-&DISTRO;</filename> tag, the | 866 | Following is an example: |
873 | <filename>master</filename> documentation | ||
874 | branch, and | ||
875 | <filename>&DISTRO_NAME_NO_CAP;</filename> for the | ||
876 | release name: | ||
877 | <literallayout class='monospaced'> | 867 | <literallayout class='monospaced'> |
878 | $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-&DISTRO; master &DISTRO_NAME_NO_CAP; 2>&1 | tee -a build.log | 868 | $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh -l neon/yocto-&DISTRO; master yocto-&DISTRO; 2>&1 | tee build.log |
879 | </literallayout> | 869 | </literallayout> |
870 | The previous example command adds the tag you | ||
871 | need for | ||
872 | <filename>mars/yocto-&DISTRO;</filename> | ||
873 | to <filename>HEAD</filename>, then tells the | ||
874 | build script to use the local (-l) Git checkout | ||
875 | for the build. | ||
880 | After running the script, the file | 876 | After running the script, the file |
881 | <filename>org.yocto.sdk-</filename><replaceable>release</replaceable><filename>-</filename><replaceable>date</replaceable><filename>-archive.zip</filename> | 877 | <filename>org.yocto.sdk-</filename><replaceable>release</replaceable><filename>-</filename><replaceable>date</replaceable><filename>-archive.zip</filename> |
882 | is in the current directory. | 878 | is in the current directory. |
@@ -887,12 +883,13 @@ | |||
887 | <listitem><para>Select "Install New Software" from | 883 | <listitem><para>Select "Install New Software" from |
888 | the "Help" pull-down menu. | 884 | the "Help" pull-down menu. |
889 | </para></listitem> | 885 | </para></listitem> |
890 | <listitem><para>Click "Add".</para></listitem> | 886 | <listitem><para>Click "Add". |
887 | </para></listitem> | ||
891 | <listitem><para>Provide anything you want in the | 888 | <listitem><para>Provide anything you want in the |
892 | "Name" field. | 889 | "Name" field. |
893 | </para></listitem> | 890 | </para></listitem> |
894 | <listitem><para>Click "Archive" and browse to the | 891 | <listitem><para>Click "Archive" and browse to the |
895 | ZIP file you built in step eight. | 892 | ZIP file you built earlier. |
896 | This ZIP file should not be "unzipped", and must | 893 | This ZIP file should not be "unzipped", and must |
897 | be the <filename>*archive.zip</filename> file | 894 | be the <filename>*archive.zip</filename> file |
898 | created by running the | 895 | created by running the |
@@ -902,10 +899,20 @@ | |||
902 | </para></listitem> | 899 | </para></listitem> |
903 | <listitem><para>Check the boxes that appear in | 900 | <listitem><para>Check the boxes that appear in |
904 | the installation window to install the | 901 | the installation window to install the |
905 | <filename>Yocto Project ADT Plug-in</filename>, | 902 | following: |
906 | <filename>Yocto Project Bitbake Commander Plug-in</filename>, | 903 | |
907 | and the | 904 | <note><title>Developer's Note</title> |
908 | <filename>Yocto Project Documentation plug-in</filename>. | 905 | <para role='writernotes'> |
906 | Right now, a check box for BitBake Commander | ||
907 | is appearing. | ||
908 | This probably needs removed. | ||
909 | Do not check this box.</para> | ||
910 | </note> | ||
911 | |||
912 | <literallayout class='monospaced'> | ||
913 | Yocto Project SDK Plug-in | ||
914 | Yocto Project Documentation plug-in | ||
915 | </literallayout> | ||
909 | </para></listitem> | 916 | </para></listitem> |
910 | <listitem><para>Finish the installation by clicking | 917 | <listitem><para>Finish the installation by clicking |
911 | through the appropriate buttons. | 918 | through the appropriate buttons. |
@@ -922,17 +929,18 @@ | |||
922 | <para> | 929 | <para> |
923 | At this point you should be able to configure the | 930 | At this point you should be able to configure the |
924 | Eclipse Yocto Plug-in as described in the | 931 | Eclipse Yocto Plug-in as described in the |
925 | "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" | 932 | "<link linkend='mars-configuring-the-eclipse-yocto-plug-in'>Configuring the Neon Eclipse Yocto Plug-in</link>" |
926 | section.</para> | 933 | section. |
934 | </para> | ||
927 | </section> | 935 | </section> |
928 | </section> | 936 | </section> |
929 | 937 | ||
930 | <section id='configuring-the-eclipse-yocto-plug-in'> | 938 | <section id='neon-configuring-the-eclipse-yocto-plug-in'> |
931 | <title>Configuring the Eclipse Yocto Plug-in</title> | 939 | <title>Configuring the Neon Eclipse Yocto Plug-in</title> |
932 | 940 | ||
933 | <para> | 941 | <para> |
934 | Configuring the Eclipse Yocto Plug-in involves setting the | 942 | Configuring the Neon Eclipse Yocto Plug-in involves |
935 | Cross Compiler options and the Target options. | 943 | setting the Cross Compiler options and the Target options. |
936 | The configurations you choose become the default settings | 944 | The configurations you choose become the default settings |
937 | for all projects. | 945 | for all projects. |
938 | You do have opportunities to change them later when | 946 | You do have opportunities to change them later when |
@@ -946,17 +954,28 @@ | |||
946 | <listitem><para>Choose "Preferences" from the | 954 | <listitem><para>Choose "Preferences" from the |
947 | "Window" menu to display the Preferences Dialog. | 955 | "Window" menu to display the Preferences Dialog. |
948 | </para></listitem> | 956 | </para></listitem> |
949 | <listitem><para>Click "Yocto Project ADT" to display | 957 | <listitem><para>Click "Yocto Project SDK" to display |
950 | the configuration screen. | 958 | the configuration screen. |
951 | </para></listitem> | 959 | </para></listitem> |
952 | </itemizedlist> | 960 | </itemizedlist> |
961 | The following sub-sections describe how to configure the | ||
962 | the plug-in. | ||
963 | <note> | ||
964 | Throughout the descriptions, a start-to-finish example for | ||
965 | preparing a QEMU image for use with Eclipse is referenced | ||
966 | as the "wiki" and is linked to the example on the | ||
967 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'> Cookbook guide to Making an Eclipse Debug Capable Image</ulink> | ||
968 | wiki page. | ||
969 | </note> | ||
953 | </para> | 970 | </para> |
954 | 971 | ||
955 | <section id='configuring-the-cross-compiler-options'> | 972 | <section id='neon-configuring-the-cross-compiler-options'> |
956 | <title>Configuring the Cross-Compiler Options</title> | 973 | <title>Configuring the Cross-Compiler Options</title> |
957 | 974 | ||
958 | <para> | 975 | <para> |
959 | To configure the Cross Compiler Options, you must select | 976 | Cross Compiler options enable Eclipse to use your specific |
977 | cross compiler toolchain. | ||
978 | To configure these options, you must select | ||
960 | the type of toolchain, point to the toolchain, specify | 979 | the type of toolchain, point to the toolchain, specify |
961 | the sysroot location, and select the target | 980 | the sysroot location, and select the target |
962 | architecture. | 981 | architecture. |
@@ -970,7 +989,7 @@ | |||
970 | <itemizedlist> | 989 | <itemizedlist> |
971 | <listitem><para><emphasis> | 990 | <listitem><para><emphasis> |
972 | <filename>Standalone Pre-built Toolchain:</filename></emphasis> | 991 | <filename>Standalone Pre-built Toolchain:</filename></emphasis> |
973 | Select this mode when you are using | 992 | Select this type when you are using |
974 | a stand-alone cross-toolchain. | 993 | a stand-alone cross-toolchain. |
975 | For example, suppose you are an | 994 | For example, suppose you are an |
976 | application developer and do not | 995 | application developer and do not |
@@ -978,45 +997,66 @@ | |||
978 | Instead, you just want to use an | 997 | Instead, you just want to use an |
979 | architecture-specific toolchain on | 998 | architecture-specific toolchain on |
980 | an existing kernel and target root | 999 | an existing kernel and target root |
981 | filesystem.</para></listitem> | 1000 | filesystem. |
982 | <listitem><para><emphasis> | 1001 | In other words, you have downloaded |
1002 | and installed a pre-built toolchain | ||
1003 | for an existing image. | ||
1004 | </para></listitem> | ||
1005 | <listitem><para><emphasis> | ||
983 | <filename>Build System Derived Toolchain:</filename></emphasis> | 1006 | <filename>Build System Derived Toolchain:</filename></emphasis> |
984 | Select this mode if the | 1007 | Select this type if you built the |
985 | cross-toolchain has been installed | 1008 | toolchain as part of the |
986 | and built as part of the | ||
987 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1009 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
988 | When you select | 1010 | When you select |
989 | <filename>Build system derived toolchain</filename>, | 1011 | <filename>Build system derived toolchain</filename>, |
990 | you are using the toolchain bundled | 1012 | you are using the toolchain built and |
991 | inside the Build Directory. | 1013 | bundled inside the Build Directory. |
1014 | For example, suppose you created a | ||
1015 | suitable image using the steps in the | ||
1016 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | ||
1017 | In this situation, you would select the | ||
1018 | <filename>Build system derived toolchain</filename>. | ||
992 | </para></listitem> | 1019 | </para></listitem> |
993 | </itemizedlist> | 1020 | </itemizedlist> |
994 | </para></listitem> | 1021 | </para></listitem> |
995 | <listitem><para><emphasis>Point to the Toolchain:</emphasis> | 1022 | <listitem><para><emphasis>Specify the Toolchain Root Location:</emphasis> |
996 | If you are using a stand-alone pre-built | 1023 | If you are using a stand-alone pre-built |
997 | toolchain, you should be pointing to where it is | 1024 | toolchain, you should be pointing to where it is |
998 | installed. | 1025 | installed (e.g. |
1026 | <filename>/opt/poky/&DISTRO;</filename>). | ||
999 | See the | 1027 | See the |
1000 | "<link linkend='sdk-installing-the-sdk'>Installing the SDK</link>" | 1028 | "<link linkend='sdk-installing-the-sdk'>Installing the SDK</link>" |
1001 | section for information about how the SDK is | 1029 | section for information about how the SDK is |
1002 | installed.</para> | 1030 | installed.</para> |
1003 | <para>If you are using a system-derived | 1031 | <para>If you are using a build system derived |
1004 | toolchain, the path you provide for the | 1032 | toolchain, the path you provide for the |
1005 | <filename>Toolchain Root Location</filename> | 1033 | <filename>Toolchain Root Location</filename> |
1006 | field is the | 1034 | field is the |
1007 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1035 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
1008 | See the | 1036 | from which you run the |
1037 | <filename>bitbake</filename> command (e.g | ||
1038 | <filename>/home/scottrif/poky/build</filename>).</para> | ||
1039 | <para>For more information, see the | ||
1009 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | 1040 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" |
1010 | section.</para></listitem> | 1041 | section. |
1011 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> | 1042 | </para></listitem> |
1043 | <listitem><para><emphasis>Specify Sysroot Location:</emphasis> | ||
1012 | This location is where the root filesystem for | 1044 | This location is where the root filesystem for |
1013 | the target hardware resides. | 1045 | the target hardware resides. |
1014 | </para> | 1046 | </para> |
1015 | <para>The location of | 1047 | <para>This location depends on where you |
1016 | the sysroot filesystem depends on where you | 1048 | separately extracted and installed the target |
1017 | separately extracted and installed the | 1049 | filesystem. |
1018 | filesystem.</para> | 1050 | As an example, suppose you prepared an image |
1019 | <para>For information on how to install the | 1051 | using the steps in the |
1052 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | ||
1053 | If so, the <filename>MY_QEMU_ROOTFS</filename> | ||
1054 | directory is found in the | ||
1055 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
1056 | and you would browse to and select that directory | ||
1057 | (e.g. <filename>/home/scottrif/poky/build/MY_QEMU_ROOTFS</filename>). | ||
1058 | </para> | ||
1059 | <para>For more information on how to install the | ||
1020 | toolchain and on how to extract and install the | 1060 | toolchain and on how to extract and install the |
1021 | sysroot filesystem, see the | 1061 | sysroot filesystem, see the |
1022 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | 1062 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" |
@@ -1035,12 +1075,15 @@ | |||
1035 | See the | 1075 | See the |
1036 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 1076 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" |
1037 | section of the Yocto Project Quick Start for | 1077 | section of the Yocto Project Quick Start for |
1038 | more information.</para></listitem> | 1078 | more information. |
1079 | You can also see the | ||
1080 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | ||
1081 | </para></listitem> | ||
1039 | </itemizedlist> | 1082 | </itemizedlist> |
1040 | </para> | 1083 | </para> |
1041 | </section> | 1084 | </section> |
1042 | 1085 | ||
1043 | <section id='configuring-the-target-options'> | 1086 | <section id='neon-configuring-the-target-options'> |
1044 | <title>Configuring the Target Options</title> | 1087 | <title>Configuring the Target Options</title> |
1045 | 1088 | ||
1046 | <para> | 1089 | <para> |
@@ -1054,16 +1097,24 @@ | |||
1054 | If you are using the emulator, you also need to | 1097 | If you are using the emulator, you also need to |
1055 | locate the kernel and specify any custom | 1098 | locate the kernel and specify any custom |
1056 | options.</para> | 1099 | options.</para> |
1057 | <para>If you selected | 1100 | <para>If you selected the |
1058 | <filename>Build system derived toolchain</filename>, | 1101 | <filename>Build system derived toolchain</filename>, |
1059 | the target kernel you built will be located in | 1102 | the target kernel you built will be located in |
1060 | the Build Directory in | 1103 | the |
1104 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
1105 | in | ||
1061 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> | 1106 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> |
1062 | directory. | 1107 | directory. |
1063 | If you selected | 1108 | As an example, suppose you performed the steps in |
1064 | <filename>Standalone pre-built toolchain</filename>, | 1109 | the |
1065 | the pre-built image you downloaded is located | 1110 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. |
1066 | in the directory you specified when you | 1111 | In this case, you specify your Build Directory path |
1112 | followed by the image (e.g. | ||
1113 | <filename>/home/scottrif/poky/build/tmp/deploy/images/qemux86/bzImage-qemux86.bin</filename>). | ||
1114 | </para> | ||
1115 | <para>If you selected the standalone pre-built | ||
1116 | toolchain, the pre-built image you downloaded is | ||
1117 | located in the directory you specified when you | ||
1067 | downloaded the image.</para> | 1118 | downloaded the image.</para> |
1068 | <para>Most custom options are for advanced QEMU | 1119 | <para>Most custom options are for advanced QEMU |
1069 | users to further customize their QEMU instance. | 1120 | users to further customize their QEMU instance. |
@@ -1095,13 +1146,14 @@ | |||
1095 | </para> | 1146 | </para> |
1096 | 1147 | ||
1097 | <para> | 1148 | <para> |
1098 | Click the "OK" to save your plug-in configurations. | 1149 | Click the "Apply" and "OK" to save your plug-in |
1150 | configurations. | ||
1099 | </para> | 1151 | </para> |
1100 | </section> | 1152 | </section> |
1101 | </section> | 1153 | </section> |
1102 | </section> | 1154 | </section> |
1103 | 1155 | ||
1104 | <section id='creating-the-project'> | 1156 | <section id='neon-creating-the-project'> |
1105 | <title>Creating the Project</title> | 1157 | <title>Creating the Project</title> |
1106 | 1158 | ||
1107 | <para> | 1159 | <para> |
@@ -1124,52 +1176,50 @@ | |||
1124 | To create a project based on a Yocto template and then display | 1176 | To create a project based on a Yocto template and then display |
1125 | the source code, follow these steps: | 1177 | the source code, follow these steps: |
1126 | <orderedlist> | 1178 | <orderedlist> |
1127 | <listitem><para>Select "Project" from the "File -> New" menu. | 1179 | <listitem><para>Select "C Project" from the "File -> New" menu. |
1128 | </para></listitem> | ||
1129 | <listitem><para>Double click <filename>CC++</filename>. | ||
1130 | </para></listitem> | 1180 | </para></listitem> |
1131 | <listitem><para>Double click <filename>C Project</filename> | 1181 | <listitem><para>Expand <filename>Yocto Project SDK Autotools Project</filename>. |
1132 | to create the project.</para></listitem> | ||
1133 | <listitem><para>Expand <filename>Yocto Project ADT Autotools Project</filename>. | ||
1134 | </para></listitem> | 1182 | </para></listitem> |
1135 | <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. | 1183 | <listitem><para>Select <filename>Hello World ANSI C Autotools Projects</filename>. |
1136 | This is an Autotools-based project based on a Yocto | 1184 | This is an Autotools-based project based on a Yocto |
1137 | template.</para></listitem> | 1185 | template. |
1186 | </para></listitem> | ||
1138 | <listitem><para>Put a name in the <filename>Project name:</filename> | 1187 | <listitem><para>Put a name in the <filename>Project name:</filename> |
1139 | field. | 1188 | field. |
1140 | Do not use hyphens as part of the name. | 1189 | Do not use hyphens as part of the name |
1190 | (e.g. <filename>hello</filename>). | ||
1191 | </para></listitem> | ||
1192 | <listitem><para>Click "Next". | ||
1141 | </para></listitem> | 1193 | </para></listitem> |
1142 | <listitem><para>Click "Next".</para></listitem> | 1194 | <listitem><para>Add appropriate information in the various |
1143 | <listitem><para>Add information in the | 1195 | fields. |
1144 | <filename>Author</filename> and | 1196 | </para></listitem> |
1145 | <filename>Copyright notice</filename> fields. | 1197 | <listitem><para>Click "Finish". |
1146 | </para></listitem> | 1198 | </para></listitem> |
1147 | <listitem><para>Be sure the <filename>License</filename> | ||
1148 | field is correct.</para></listitem> | ||
1149 | <listitem><para>Click "Finish".</para></listitem> | ||
1150 | <listitem><para>If the "open perspective" prompt appears, | 1199 | <listitem><para>If the "open perspective" prompt appears, |
1151 | click "Yes" so that you in the C/C++ perspective. | 1200 | click "Yes" so that you in the C/C++ perspective. |
1152 | </para></listitem> | 1201 | </para></listitem> |
1153 | <listitem><para>The left-hand navigation pane shows your | 1202 | <listitem><para>The left-hand navigation pane shows your |
1154 | project. | 1203 | project. |
1155 | You can display your source by double clicking the | 1204 | You can display your source by double clicking the |
1156 | project's source file.</para></listitem> | 1205 | project's source file. |
1206 | </para></listitem> | ||
1157 | </orderedlist> | 1207 | </orderedlist> |
1158 | </para> | 1208 | </para> |
1159 | </section> | 1209 | </section> |
1160 | 1210 | ||
1161 | <section id='configuring-the-cross-toolchains'> | 1211 | <section id='neon-configuring-the-cross-toolchains'> |
1162 | <title>Configuring the Cross-Toolchains</title> | 1212 | <title>Configuring the Cross-Toolchains</title> |
1163 | 1213 | ||
1164 | <para> | 1214 | <para> |
1165 | The earlier section, | 1215 | The earlier section, |
1166 | "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>", | 1216 | "<link linkend='mars-configuring-the-eclipse-yocto-plug-in'>Configuring the Mars Eclipse Yocto Plug-in</link>", |
1167 | sets up the default project configurations. | 1217 | sets up the default project configurations. |
1168 | You can override these settings for a given project by following | 1218 | You can override these settings for a given project by following |
1169 | these steps: | 1219 | these steps: |
1170 | <orderedlist> | 1220 | <orderedlist> |
1171 | <listitem><para>Select "Change Yocto Project Settings" from | 1221 | <listitem><para>Select "Yocto Project Settings" from |
1172 | the "Project" menu. | 1222 | the "Project -> Properties" menu. |
1173 | This selection brings up the Yocto Project Settings | 1223 | This selection brings up the Yocto Project Settings |
1174 | Dialog and allows you to make changes specific to an | 1224 | Dialog and allows you to make changes specific to an |
1175 | individual project.</para> | 1225 | individual project.</para> |
@@ -1177,12 +1227,12 @@ | |||
1177 | Options for a project are inherited from settings you | 1227 | Options for a project are inherited from settings you |
1178 | provided using the Preferences Dialog as described | 1228 | provided using the Preferences Dialog as described |
1179 | earlier in the | 1229 | earlier in the |
1180 | "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section. | 1230 | "<link linkend='mars-configuring-the-eclipse-yocto-plug-in'>Configuring the Mars Eclipse Yocto Plug-in</link>" section. |
1181 | The Yocto Project Settings Dialog allows you to override | 1231 | The Yocto Project Settings Dialog allows you to override |
1182 | those default settings for a given project. | 1232 | those default settings for a given project. |
1183 | </para></listitem> | 1233 | </para></listitem> |
1184 | <listitem><para>Make your configurations for the project | 1234 | <listitem><para>Make or verify your configurations for the |
1185 | and click "OK". | 1235 | project and click "OK". |
1186 | </para></listitem> | 1236 | </para></listitem> |
1187 | <listitem><para>Right-click in the navigation pane and | 1237 | <listitem><para>Right-click in the navigation pane and |
1188 | select "Reconfigure Project" from the pop-up menu. | 1238 | select "Reconfigure Project" from the pop-up menu. |
@@ -1202,20 +1252,20 @@ | |||
1202 | </para> | 1252 | </para> |
1203 | </section> | 1253 | </section> |
1204 | 1254 | ||
1205 | <section id='building-the-project'> | 1255 | <section id='neon-building-the-project'> |
1206 | <title>Building the Project</title> | 1256 | <title>Building the Project</title> |
1207 | 1257 | ||
1208 | <para> | 1258 | <para> |
1209 | To build the project select "Build Project" from the | 1259 | To build the project select "Build All" from the |
1210 | "Project" menu. | 1260 | "Project" menu. |
1211 | The console should update and you can note the cross-compiler | 1261 | The console should update and you can note the cross-compiler |
1212 | you are using. | 1262 | you are using. |
1213 | <note> | 1263 | <note> |
1214 | When building "Yocto Project ADT Autotools" projects, the Eclipse | 1264 | When building "Yocto Project SDK Autotools" projects, the |
1215 | IDE might display error messages for Functions/Symbols/Types | 1265 | Eclipse IDE might display error messages for |
1216 | that cannot be "resolved", even when the related include file | 1266 | Functions/Symbols/Types that cannot be "resolved", even when |
1217 | is listed at the project navigator and when the project is | 1267 | the related include file is listed at the project navigator and |
1218 | able to build. | 1268 | when the project is able to build. |
1219 | For these cases only, it is recommended to add a new linked | 1269 | For these cases only, it is recommended to add a new linked |
1220 | folder to the appropriate sysroot. | 1270 | folder to the appropriate sysroot. |
1221 | Use these steps to add the linked folder: | 1271 | Use these steps to add the linked folder: |
@@ -1247,7 +1297,7 @@ | |||
1247 | </para> | 1297 | </para> |
1248 | </section> | 1298 | </section> |
1249 | 1299 | ||
1250 | <section id='starting-qemu-in-user-space-nfs-mode'> | 1300 | <section id='neon-starting-qemu-in-user-space-nfs-mode'> |
1251 | <title>Starting QEMU in User-Space NFS Mode</title> | 1301 | <title>Starting QEMU in User-Space NFS Mode</title> |
1252 | 1302 | ||
1253 | <para> | 1303 | <para> |
@@ -1259,31 +1309,65 @@ | |||
1259 | chapter in the Yocto Project Development Manual | 1309 | chapter in the Yocto Project Development Manual |
1260 | for more information on using QEMU. | 1310 | for more information on using QEMU. |
1261 | </note> | 1311 | </note> |
1262 | <orderedlist> | 1312 | <orderedlist> |
1263 | <listitem><para>Expose and select "External Tools" from | 1313 | <listitem><para>Expose and select "External Tools |
1264 | the "Run" menu. | 1314 | Configurations ..." from the "Run -> External Tools" menu. |
1265 | Your image should appear as a selectable menu item. | ||
1266 | </para></listitem> | 1315 | </para></listitem> |
1267 | <listitem><para>Select your image from the menu to launch | 1316 | <listitem><para> |
1268 | the emulator in a new window. | 1317 | Locate and select your image in the navigation panel to |
1318 | the left (e.g. <filename>qemu_i586-poky-linux</filename>). | ||
1319 | </para></listitem> | ||
1320 | <listitem><para> | ||
1321 | Click "Run" to launch QEMU. | ||
1322 | <note> | ||
1323 | The host on which you are running QEMU must have | ||
1324 | the <filename>rpcbind</filename> utility running to be | ||
1325 | able to make RPC calls on a server on that machine. | ||
1326 | If QEMU does not invoke and you receive error messages | ||
1327 | involving <filename>rpcbind</filename>, follow the | ||
1328 | suggestions to get the service running. | ||
1329 | As an example, on a new Ubuntu 16.04 LTS installation, | ||
1330 | you must do the following in order to get QEMU to | ||
1331 | launch: | ||
1332 | <literallayout class='monospaced'> | ||
1333 | $ sudo apt-get install rpcbind | ||
1334 | </literallayout> | ||
1335 | After installing <filename>rpcbind</filename>, you | ||
1336 | need to edit the | ||
1337 | <filename>/etc/init.d/rpcbind</filename> file to | ||
1338 | include the following line: | ||
1339 | <literallayout class='monospaced'> | ||
1340 | OPTIONS="-i -w" | ||
1341 | </literallayout> | ||
1342 | After modifying the file, you need to start the | ||
1343 | service: | ||
1344 | <literallayout class='monospaced'> | ||
1345 | $ sudo service portmap restart | ||
1346 | </literallayout> | ||
1347 | </note> | ||
1269 | </para></listitem> | 1348 | </para></listitem> |
1270 | <listitem><para>If needed, enter your host root password in | 1349 | <listitem><para>If needed, enter your host root password in |
1271 | the shell window at the prompt. | 1350 | the shell window at the prompt. |
1272 | This sets up a <filename>Tap 0</filename> connection | 1351 | This sets up a <filename>Tap 0</filename> connection |
1273 | needed for running in user-space NFS mode. | 1352 | needed for running in user-space NFS mode. |
1274 | </para></listitem> | 1353 | </para></listitem> |
1275 | <listitem><para>Wait for QEMU to launch.</para></listitem> | 1354 | <listitem><para>Wait for QEMU to launch. |
1355 | </para></listitem> | ||
1276 | <listitem><para>Once QEMU launches, you can begin operating | 1356 | <listitem><para>Once QEMU launches, you can begin operating |
1277 | within that environment. | 1357 | within that environment. |
1278 | One useful task at this point would be to determine the | 1358 | One useful task at this point would be to determine the |
1279 | IP Address for the user-space NFS by using the | 1359 | IP Address for the user-space NFS by using the |
1280 | <filename>ifconfig</filename> command. | 1360 | <filename>ifconfig</filename> command. |
1281 | </para></listitem> | 1361 | The IP address of the QEMU machine appears in the |
1362 | xterm window. | ||
1363 | You can use this address to help you see which particular | ||
1364 | IP address the instance of QEMU is using. | ||
1365 | </para></listitem> | ||
1282 | </orderedlist> | 1366 | </orderedlist> |
1283 | </para> | 1367 | </para> |
1284 | </section> | 1368 | </section> |
1285 | 1369 | ||
1286 | <section id='deploying-and-debugging-the-application'> | 1370 | <section id='neon-deploying-and-debugging-the-application'> |
1287 | <title>Deploying and Debugging the Application</title> | 1371 | <title>Deploying and Debugging the Application</title> |
1288 | 1372 | ||
1289 | <para> | 1373 | <para> |
@@ -1299,7 +1383,11 @@ | |||
1299 | that connection alive during your work. | 1383 | that connection alive during your work. |
1300 | For example, in a new terminal, run the following: | 1384 | For example, in a new terminal, run the following: |
1301 | <literallayout class='monospaced'> | 1385 | <literallayout class='monospaced'> |
1302 | ssh -XY user_name@remote_host_ip | 1386 | $ ssh -XY <replaceable>user_name</replaceable>@<replaceable>remote_host_ip</replaceable> |
1387 | </literallayout> | ||
1388 | Using the above form, here is an example: | ||
1389 | <literallayout class='monospaced'> | ||
1390 | $ ssh -XY root@192.168.7.2 | ||
1303 | </literallayout> | 1391 | </literallayout> |
1304 | After running the command, add the command to be executed | 1392 | After running the command, add the command to be executed |
1305 | in Eclipse's run configuration before the application | 1393 | in Eclipse's run configuration before the application |
@@ -1307,6 +1395,9 @@ | |||
1307 | <literallayout class='monospaced'> | 1395 | <literallayout class='monospaced'> |
1308 | export DISPLAY=:10.0 | 1396 | export DISPLAY=:10.0 |
1309 | </literallayout> | 1397 | </literallayout> |
1398 | Be sure to not destroy the connection during your QEMU | ||
1399 | session (i.e. do not | ||
1400 | exit out of or close that shell). | ||
1310 | </note> | 1401 | </note> |
1311 | <orderedlist> | 1402 | <orderedlist> |
1312 | <listitem><para>Select "Debug Configurations..." from the | 1403 | <listitem><para>Select "Debug Configurations..." from the |
@@ -1317,47 +1408,83 @@ | |||
1317 | <listitem><para>Locate your project and select it to bring | 1408 | <listitem><para>Locate your project and select it to bring |
1318 | up a new tabbed view in the Debug Configurations Dialog. | 1409 | up a new tabbed view in the Debug Configurations Dialog. |
1319 | </para></listitem> | 1410 | </para></listitem> |
1320 | <listitem><para>Enter the absolute path into which you want | ||
1321 | to deploy the application. | ||
1322 | Use the "Remote Absolute File Path for | ||
1323 | C/C++Application:" field. | ||
1324 | For example, enter | ||
1325 | <filename>/usr/bin/<replaceable>programname</replaceable></filename>. | ||
1326 | </para></listitem> | ||
1327 | <listitem><para>Click on the "Debugger" tab to see the | 1411 | <listitem><para>Click on the "Debugger" tab to see the |
1328 | cross-tool debugger you are using.</para></listitem> | 1412 | cross-tool debugger you are using. |
1329 | <listitem><para>Click on the "Main" tab.</para></listitem> | 1413 | Be sure to change to the debugger perspective in Eclipse. |
1414 | </para></listitem> | ||
1415 | <listitem><para>Click on the "Main" tab. | ||
1416 | </para></listitem> | ||
1330 | <listitem><para>Create a new connection to the QEMU instance | 1417 | <listitem><para>Create a new connection to the QEMU instance |
1331 | by clicking on "new".</para></listitem> | 1418 | by clicking on "new".</para></listitem> |
1332 | <listitem><para>Select <filename>TCF</filename>, which means | 1419 | <listitem><para>Select <filename>SSH</filename>, which means |
1333 | Target Communication Framework.</para></listitem> | 1420 | Secure Socket Shell and then click "OK". |
1334 | <listitem><para>Click "Next".</para></listitem> | 1421 | Optionally, you can select an TCF connection instead. |
1335 | <listitem><para>Clear out the "host name" field and enter | 1422 | </para></listitem> |
1336 | the IP Address determined earlier.</para></listitem> | 1423 | <listitem><para>Clear out the "Connection name" field and enter |
1424 | the IP Address determined earlier (e.g. 192.168.7.2). | ||
1425 | </para></listitem> | ||
1426 | <listitem><para>Put the IP address for the connection in | ||
1427 | "Host" field. | ||
1428 | </para></listitem> | ||
1429 | <listitem><para>Provide <filename>root</filename> for the | ||
1430 | "User" field. | ||
1431 | </para></listitem> | ||
1337 | <listitem><para>Click "Finish" to close the | 1432 | <listitem><para>Click "Finish" to close the |
1338 | New Connections Dialog.</para></listitem> | 1433 | New Connections Dialog. |
1339 | <listitem><para>Use the drop-down menu now in the | 1434 | </para></listitem> |
1435 | <listitem><para>If necessary, use the drop-down menu now in the | ||
1340 | "Connection" field and pick the IP Address you entered. | 1436 | "Connection" field and pick the IP Address you entered. |
1341 | </para></listitem> | 1437 | </para></listitem> |
1342 | <listitem><para>Click "Debug" to bring up a login screen | 1438 | <listitem><para>Assuming you are connecting as the root |
1343 | and login.</para></listitem> | 1439 | user, which is the default for QEMU x86-64 SDK images |
1440 | provided by the Yocto Project, in the "Remote Absolute | ||
1441 | File Path for C/C++ Application" field, browse to | ||
1442 | <filename>/home/root/</filename><replaceable>ProjectName</replaceable> | ||
1443 | (e.g. <filename>/home/root/hello</filename>). | ||
1444 | You could also browse to any other path you have write | ||
1445 | access to on the target such as | ||
1446 | <filename>/usr/bin</filename>. | ||
1447 | This location is where your application will be located | ||
1448 | on the QEMU system. | ||
1449 | If you fail to browse to and specify an appropriate | ||
1450 | location, QEMU will not understand what to remotely | ||
1451 | launch. | ||
1452 | Eclipse is helpful in that it auto fills your | ||
1453 | application name for you assuming you browsed to a | ||
1454 | directory. | ||
1455 | <note> | ||
1456 | If you are prompted to provide a username and to | ||
1457 | optionally set a password, be sure you provide | ||
1458 | "root" as the username and you leave the password | ||
1459 | field blank. | ||
1460 | </note> | ||
1461 | </para></listitem> | ||
1462 | <listitem><para> | ||
1463 | Be sure you change to the "Debug" perspective in | ||
1464 | Eclipse. | ||
1465 | </para></listitem> | ||
1466 | <listitem><para>Click "Debug" | ||
1467 | </para></listitem> | ||
1344 | <listitem><para>Accept the debug perspective. | 1468 | <listitem><para>Accept the debug perspective. |
1345 | </para></listitem> | 1469 | </para></listitem> |
1346 | </orderedlist> | 1470 | </orderedlist> |
1347 | </para> | 1471 | </para> |
1348 | </section> | 1472 | </section> |
1349 | 1473 | ||
1350 | <section id='running-performance-tools'> | 1474 | <section id='neon-using-Linuxtools'> |
1351 | <title>Running Performance Tools</title> | 1475 | <title>Using Linuxtools</title> |
1476 | |||
1477 | <para> | ||
1478 | As mentioned earlier in the manual, performance tools exist | ||
1479 | (Linuxtools) that enhance your development experience. | ||
1480 | These tools are aids in developing and debugging applications and | ||
1481 | images. | ||
1482 | You can run these tools from within the Eclipse IDE through the | ||
1483 | "Linuxtools" menu. | ||
1484 | </para> | ||
1352 | 1485 | ||
1353 | <para> | 1486 | <para> |
1354 | As mentioned earlier in the manual, several tools exist that | 1487 | For information on how to configure and use these tools, see |
1355 | enhance your development experience. | ||
1356 | These tools are aids in developing and debugging applications | ||
1357 | and images. | ||
1358 | You can run these tools from within the Eclipse | ||
1359 | IDE through the "YoctoProjectTools" menu. | ||
1360 | For more information on these tools, see | ||
1361 | <ulink url='http://www.eclipse.org/linuxtools/'>http://www.eclipse.org/linuxtools/</ulink>. | 1488 | <ulink url='http://www.eclipse.org/linuxtools/'>http://www.eclipse.org/linuxtools/</ulink>. |
1362 | </para> | 1489 | </para> |
1363 | </section> | 1490 | </section> |