summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-03-23 08:46:27 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-23 21:56:10 +0000
commit64241e0dfbeb566279a07995851fb3e16f54ba0c (patch)
tree9d26f95686f3b507cf621ec10a721066f6c7c09a
parentb44d9e553a84e07e34c2c1a74523473631e8e1d5 (diff)
downloadpoky-64241e0dfbeb566279a07995851fb3e16f54ba0c.tar.gz
sdk-manual: Applied more review edits to the manual per Eggleton.
(From yocto-docs rev: 8987852ad23e8a4694be55425e2c76bcd4301850) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml51
-rw-r--r--documentation/sdk-manual/sdk-using.xml1
2 files changed, 40 insertions, 12 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index e43c98ecee..f9f6260a90 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -95,24 +95,53 @@
95 <title>Using <filename>devtool</filename> in Your SDK Workflow</title> 95 <title>Using <filename>devtool</filename> in Your SDK Workflow</title>
96 96
97 <para> 97 <para>
98 <filename>devtool</filename> helps you easily develop projects whose 98 The cornerstone of the extensible SDK is a command-line tool
99 build output must be part of an image built using the OpenEmbedded 99 called <filename>devtool</filename>.
100 build system. 100 This tool provides a number of features that help
101 you build, test and package software within the extensible SDK, and
102 optionally integrate it into an image built by the OpenEmbedded build
103 system.
101 </para> 104 </para>
102 105
103 <para> 106 <para>
104 These entry points exist that allow you to develop using 107 The <filename>devtool</filename> command line is organized similarly
105 <filename>devtool</filename>: 108 to
109 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> in that it has a
110 number of sub-commands for each function.
111 You can run <filename>devtool --help</filename> to see all the
112 commands.
113 </para>
114
115 <para>
116 Two <filename>devtool</filename> subcommands that provide
117 entry-points into development are:
106 <itemizedlist> 118 <itemizedlist>
107 <listitem><para><emphasis><filename>devtool add</filename></emphasis> 119 <listitem><para><emphasis><filename>devtool add</filename></emphasis>:
120 Assists in adding new software to be built.
108 </para></listitem> 121 </para></listitem>
109 <listitem><para><emphasis><filename>devtool modify</filename></emphasis> 122 <listitem><para><emphasis><filename>devtool modify</filename></emphasis>:
123 Sets up an environment to enable you to modify the source of
124 an existing component.
110 </para></listitem> 125 </para></listitem>
111 </itemizedlist> 126 </itemizedlist>
127 As with the OpenEmbedded build system, "recipes" represent software
128 packages within <filename>devtool</filename>.
129 When you use <filename>devtool add</filename>, a recipe is
130 automatically created.
131 When you use <filename>devtool modify</filename>, the specified
132 existing recipe is used in order to determine where to get the source
133 code and how to patch it.
134 In both cases, an environment is set up so that when you build the
135 recipe a source tree that is under your control is used in order to
136 allow you to make changes to the source as desired.
137 By default, both new recipes and the source go into a "workspace"
138 directory under the SDK.
112 </para> 139 </para>
113 140
114 <para> 141 <para>
115 The remainder of this section presents these workflows. 142 The remainder of this section presents the
143 <filename>devtool add</filename> and
144 <filename>devtool modify</filename> workflows.
116 </para> 145 </para>
117 146
118 <section id='sdk-use-devtool-to-add-an-application'> 147 <section id='sdk-use-devtool-to-add-an-application'>
@@ -494,9 +523,9 @@
494 </para></listitem> 523 </para></listitem>
495 <listitem><para><emphasis>Deploy the Build Output</emphasis>: 524 <listitem><para><emphasis>Deploy the Build Output</emphasis>:
496 When you use the <filename>devtool build</filename> 525 When you use the <filename>devtool build</filename>
497 command or <filename>bitbake</filename> to build out your 526 command to build out your recipe, you probably want to see
498 recipe, you probably want to see if the resulting build 527 if the resulting build output works as expected on target
499 output works as expected on target hardware. 528 hardware.
500 <note> 529 <note>
501 This step assumes you have a previously built 530 This step assumes you have a previously built
502 image that is already either running in QEMU or 531 image that is already either running in QEMU or
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index 6ddcb45fcf..d198836922 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -109,7 +109,6 @@
109 <literallayout class='monospaced'> 109 <literallayout class='monospaced'>
110 $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-2.1.sh 110 $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-2.1.sh
111 </literallayout> 111 </literallayout>
112 This example makes the installation script executable.
113 </note> 112 </note>
114 </para> 113 </para>
115 114