summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-16 17:29:22 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-03 17:40:13 +0000
commitf33ffaa3d47813ea1cd23b98bc82eb1f59a655dd (patch)
treea4999f2054885cc174d836ea62d3873a232525fc /documentation/dev-manual
parentfe70eb29b36dfcedec06169cbde643b1ec2aec4f (diff)
downloadpoky-f33ffaa3d47813ea1cd23b98bc82eb1f59a655dd.tar.gz
dev-manual: Applied more review comments to the section.
Closing in on the devtool add and devtool modify sections. (From yocto-docs rev: 202b688c03cc1801576bbed3b771bb329f6b8520) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml38
1 files changed, 21 insertions, 17 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index cef668408a..1b9a75b61e 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -2051,10 +2051,9 @@
2051 </para> 2051 </para>
2052 2052
2053 <para>The following command identifies the recipe 2053 <para>The following command identifies the recipe
2054 and instructs <filename>devtool</filename> to 2054 and by default extracts the source files:
2055 extract the source files using the "-x" option:
2056 <literallayout class='monospaced'> 2055 <literallayout class='monospaced'>
2057 $ devtool modify -x <replaceable>recipe</replaceable> 2056 $ devtool modify <replaceable>recipe</replaceable>
2058 </literallayout> 2057 </literallayout>
2059 Once <filename>devtool</filename>locates the recipe, 2058 Once <filename>devtool</filename>locates the recipe,
2060 it uses the 2059 it uses the
@@ -2069,10 +2068,11 @@
2069 </note> 2068 </note>
2070 With this scenario, however, since no 2069 With this scenario, however, since no
2071 <replaceable>srctree</replaceable> argument exists, the 2070 <replaceable>srctree</replaceable> argument exists, the
2072 <filename>devtool modify</filename> command extracts the 2071 <filename>devtool modify</filename> command by default
2073 source files to a Git structure using the default 2072 extracts the source files to a Git structure.
2074 location within the workspace. 2073 Furthermore, the location for the extracted source is the
2075 The result is that the command set up both the source 2074 default area within the workspace.
2075 The result is that the command sets up both the source
2076 code and an append file within the workspace with the 2076 code and an append file within the workspace with the
2077 recipe remaining in its original location. 2077 recipe remaining in its original location.
2078 </para></listitem> 2078 </para></listitem>
@@ -2087,18 +2087,20 @@
2087 2087
2088 <para>The following command tells 2088 <para>The following command tells
2089 <filename>devtool</filename> what recipe with 2089 <filename>devtool</filename> what recipe with
2090 which to work and also uses the "-x" option to 2090 which to work and, in this case, identifies a local
2091 instruct <filename>devtool</filename> to locate and 2091 area for the extracted source files that is outside
2092 extract the source code: 2092 of the default workspace:
2093 <literallayout class='monospaced'> 2093 <literallayout class='monospaced'>
2094 $ devtool modify -x <replaceable>recipe srctree</replaceable> 2094 $ devtool modify <replaceable>recipe srctree</replaceable>
2095 </literallayout> 2095 </literallayout>
2096 As with all extractions, the command uses 2096 As with all extractions, the command uses
2097 the recipe's <filename>SRC_URI</filename> to locate the 2097 the recipe's <filename>SRC_URI</filename> to locate the
2098 source files. 2098 source files.
2099 Once the files are located, the command extracts 2099 Once the files are located, the command by default
2100 them to the location specified by 2100 extracts them.
2101 <replaceable>srctree</replaceable>.</para> 2101 Providing the <replaceable>srctree</replaceable>
2102 argument instructs <filename>devtool</filename> where
2103 place the extracted source.</para>
2102 2104
2103 <para>Within workspace, <filename>devtool</filename> 2105 <para>Within workspace, <filename>devtool</filename>
2104 creates an append file for the recipe. 2106 creates an append file for the recipe.
@@ -2108,7 +2110,8 @@
2108 </para></listitem> 2110 </para></listitem>
2109 <listitem><para><emphasis>Right</emphasis>: 2111 <listitem><para><emphasis>Right</emphasis>:
2110 The right scenario represents a situation 2112 The right scenario represents a situation
2111 where the source tree (srctree) exists as a 2113 where the source tree
2114 (<replaceable>srctree</replaceable>) exists as a
2112 previously extracted Git structure outside of 2115 previously extracted Git structure outside of
2113 the <filename>devtool</filename> workspace. 2116 the <filename>devtool</filename> workspace.
2114 In this example, the recipe also exists 2117 In this example, the recipe also exists
@@ -2117,11 +2120,12 @@
2117 2120
2118 <para>The following command tells 2121 <para>The following command tells
2119 <filename>devtool</filename> the recipe 2122 <filename>devtool</filename> the recipe
2120 with which to work and uses 2123 with which to work, uses the "-n" option to indicate
2124 source does not need to be extracted, and uses
2121 <replaceable>srctree</replaceable> to point to the 2125 <replaceable>srctree</replaceable> to point to the
2122 previously extracted source files: 2126 previously extracted source files:
2123 <literallayout class='monospaced'> 2127 <literallayout class='monospaced'>
2124 $ devtool modify <replaceable>recipe srctree</replaceable> 2128 $ devtool modify -n <replaceable>recipe srctree</replaceable>
2125 </literallayout> 2129 </literallayout>
2126 </para> 2130 </para>
2127 2131