[yocto] [RFC 3/3] plugins/sdk.ide.doc.user: Added cheat sheet for hello world project
Atanas Gegov
atanas.gegov.oss at gmail.com
Tue Jul 24 08:53:52 PDT 2012
From: Atanas Gegov <atanas.gegov at bmw-carit.de>
The cheat sheet added provides an interactive tutorial for creating
and building the 'Hello World C++ Autotools Project' provided with the
yocto ide. The tutorial starts of by configuring the yocto project
settings and then guides the user through the process of creating and
finally building the project.
---
.../META-INF/MANIFEST.MF | 1 +
.../OSGI-INF/l10n/bundle.properties | 4 +
.../org.yocto.sdk.ide.doc.user/build.properties | 4 +-
.../cheatsheets/createNewHelloWorldProject.xml | 187 ++++++++++++++++++++
plugins/org.yocto.sdk.ide.doc.user/plugin.xml | 9 +
5 files changed, 204 insertions(+), 1 deletions(-)
create mode 100644 plugins/org.yocto.sdk.ide.doc.user/cheatsheets/createNewHelloWorldProject.xml
diff --git a/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF b/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF
index 1c8ae05..87079ce 100644
--- a/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF
+++ b/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF
@@ -5,3 +5,4 @@ Bundle-SymbolicName: org.yocto.sdk.ide.doc.user;singleton:=true
Bundle-Version: 1.2.0.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
+Require-Bundle: org.eclipse.ui.cheatsheets
diff --git a/plugins/org.yocto.sdk.ide.doc.user/OSGI-INF/l10n/bundle.properties b/plugins/org.yocto.sdk.ide.doc.user/OSGI-INF/l10n/bundle.properties
index 99f8fce..9c77778 100644
--- a/plugins/org.yocto.sdk.ide.doc.user/OSGI-INF/l10n/bundle.properties
+++ b/plugins/org.yocto.sdk.ide.doc.user/OSGI-INF/l10n/bundle.properties
@@ -1,3 +1,7 @@
#Properties file for org.yocto.sdk.ide.doc.user
Bundle-Vendor = yoctoproject.org
Bundle-Name = Yocto User Help
+
+category.name = Yocto Project
+
+cheatsheet.name = Creating a Hello World C++ Autotools Project
\ No newline at end of file
diff --git a/plugins/org.yocto.sdk.ide.doc.user/build.properties b/plugins/org.yocto.sdk.ide.doc.user/build.properties
index 31e0140..caf850b 100644
--- a/plugins/org.yocto.sdk.ide.doc.user/build.properties
+++ b/plugins/org.yocto.sdk.ide.doc.user/build.properties
@@ -1,4 +1,6 @@
bin.includes = plugin.xml,\
.,\
META-INF/,\
- OSGI-INF/
+ OSGI-INF/,\
+ cheatsheets/
+src.includes = cheatsheets/
diff --git a/plugins/org.yocto.sdk.ide.doc.user/cheatsheets/createNewHelloWorldProject.xml b/plugins/org.yocto.sdk.ide.doc.user/cheatsheets/createNewHelloWorldProject.xml
new file mode 100644
index 0000000..327242b
--- /dev/null
+++ b/plugins/org.yocto.sdk.ide.doc.user/cheatsheets/createNewHelloWorldProject.xml
@@ -0,0 +1,187 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/*******************************************************************************
+ * Copyright (c) 2012 BMW Car IT GmbH.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Atanas Gegov - initial cheat sheet for creating the hello world project.
+ *******************************************************************************
+-->
+<cheatsheet title="Creating a Hello World C++ Autotools Project">
+ <intro>
+ <description>
+ This cheat sheet will guide you through the process of creating and
+ building a "Hello World C++ Autotools Project"
+ application that uses the Yocto Project template.
+ </description>
+ </intro>
+ <item title="Open the C/C++ Perspective" dialog="false" skip="true">
+ <description>
+ Select <b>Window</b> > <b>Open Perspective</b> >
+ <b>Other...</b> from the menu bar.<br/>
+ Choose <b>C/C++</b> from the <b>Open Perspective</b> dialog.
+ Click <b>OK</b>.
+ </description>
+ <command
+ required="false"
+ serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.cdt.ui.CPerspective)">
+ </command>
+ </item>
+ <item title="Specify a toolchain and sysroot location" dialog="true" skip="true">
+ <description>
+ You need to specify a toolchain and sysroot location before
+ building any project in the workspace.
+ </description>
+ <subitem>
+ <description>
+ The global settings can be modified in the <b>Yocto Project ADT</b>
+ section of the eclipse preferences. Select <b>Window</b> >
+ <b>Preferences</b> from the menu bar and then select the section
+ <b>Yocto Project ADT</b>. These settings are the default ones for
+ every project you create in the workspace.
+ </description>
+ <command
+ required="false"
+ serialization="org.eclipse.ui.window.preferences(preferencePageId=org.yocto.sdk.ide.preferences.YoctoSDKPreferencePage)">
+ </command>
+ </subitem>
+ <subitem>
+ <description>
+ Choose in the <b>Cross Compiler Options</b> the
+ <b>Standalone pre-built toolchain</b>.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Provide a <b>Toolchain Root Location</b> (most probably
+ /opt/poky/<Yocto version, e.g. 1.2>).
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Provide a <b>Sysroot Location</b>. This is the filesystem
+ containing libraries, headers etc. used while cross-building
+ binaries for the target.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ If more than one toolchain is found in the <b>Toolchain
+ Root Location</b>, use the drop-down box to select the <b>Target
+ Architecture</b>. Make sure that the selected sysroot matches
+ the toolchain.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Choose in the <b>Target Options</b> whether the target is a QEMU
+ emulation (kernel location required) or an external hardware.
+ The target is used for running or remote debugging the binaries
+ created for it.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Save the settings with <b>Apply</b> and <b>OK</b>. You can later
+ change these settings for any project from the menu
+ <b>Project</b> > <b>Change Yocto Project Settings</b>.
+ </description>
+ </subitem>
+ </item>
+ <item title="Create a Hello World C++ Autotools Project" dialog="true">
+ <description>
+ Create a Yocto Project ADT Project "Hello World C++ Autotools
+ Project" by using the C++ Project wizard.
+ </description>
+ <subitem>
+ <description>
+ Click <b>File</b> > <b>New</b> > <b>C++ Project</b> to
+ launch the C++ Project wizard.
+ </description>
+ <command
+ required="false"
+ serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.cdt.ui.wizards.NewCWizard1)">
+ </command>
+ </subitem>
+ <subitem>
+ <description>
+ Enter <b>HelloWorld</b> as the project name, then select
+ <b>Yocto Project ADT Project</b> >
+ <b>Hello World C++ Autotools Project</b> from the Project type
+ list and click <b>Next</b>.
+ </description>
+ </subitem>
+ <subitem skip="true">
+ <description>
+ Fill in the name of the <b>Author</b>. Make some changes in the
+ other fields if needed. Possibly change the <b>License</b> from
+ the drop-down box and click <b>Next</b>.
+ </description>
+ </subitem>
+ <subitem skip="true">
+ <description>
+ If needed make some Advanced settings. Click <b>Next</b>.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Click <b>Finish</b> to create the project in your workspace. You
+ will find the created project in the <b>Project Explorer</b> view.
+ </description>
+ </subitem>
+ </item>
+ <item title="Build the project" dialog="true">
+ <description>
+ Create the project's binary using a specified toolchain and
+ sysroot.
+ </description>
+ <subitem>
+ <description>
+ Make sure that the project is on focus in the
+ <b>Project Explorer</b> view.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ If you want to change the default settings for toolchain and
+ sysroot location go to <b>Project</b> >
+ <b>Change Yocto Project Settings</b> in the menu bar. Finish the
+ editing by pressing <b>OK</b>.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ If you have changed the settings in the previous step, call
+ <b>Project</b> > <b>Reconfigure Project</b> to reconfigure the
+ project with these new settings (e.g. create the correct Makefiles
+ that make use of the selected toolchain and sysroot).
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Build the project with a click on the hammer symbol in the
+ Toolbar. Alternatively, go to <b>Project</b> >
+ <b>Build Project</b>. If you didn't change the default
+ toolchain and sysroot, now the configuring step will be executed
+ at first, followed by the build step itself.
+ </description>
+ </subitem>
+ <subitem>
+ <description>
+ Observe the output in the different consoles (e.g.
+ <b>Configure [HelloWorld]</b> and
+ <b>CDT Build Console [HelloWorld]</b>) to check if everything
+ was successful.
+ </description>
+ </subitem>
+ <onCompletion>
+ Congratulations, you have completed this cheat sheet! You may
+ continue with editing, rebuilding or debugging the
+ Hello World C++ Autotools Project.
+ </onCompletion>
+ </item>
+</cheatsheet>
diff --git a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml
index f422d55..24c539d 100644
--- a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml
+++ b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml
@@ -1,4 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
+ <extension point="org.eclipse.ui.cheatsheets.cheatSheetContent">
+ <category id="org.yocto.sdk.ide.doc.user.cheatsheets" name="%category.name">
+ </category>
+ <cheatsheet category="org.yocto.sdk.ide.doc.user.cheatsheets"
+ composite="false" contentFile="cheatsheets/createNewHelloWorldProject.xml"
+ id="org.yocto.sdk.ide.doc.user.cheatsheet.helloworldProject"
+ name="%cheatsheet.name">
+ </cheatsheet>
+ </extension>
</plugin>
--
1.7.5.4
More information about the yocto
mailing list