summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-03-29 17:31:25 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-04-01 12:59:12 +0100
commite1ff065baea754c3e19acf254e07930370a11ca6 (patch)
treec93a6dc80e888db31a4e47826909590bf57171bb
parentabf3039a892b1625cc1545abd90897fa74124543 (diff)
downloadpoky-e1ff065baea754c3e19acf254e07930370a11ca6.tar.gz
dev-manual: Applied review edits to the devtool section.
Paul Eggleton reviewed the section. (From yocto-docs rev: 82d9750b4349b3c54f73118ec7d65f0bb96e3f7a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml20
-rw-r--r--documentation/dev-manual/dev-manual-model.xml218
2 files changed, 130 insertions, 108 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 3e48c0add5..79a3da3437 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -448,11 +448,6 @@
448 $HOME/poky/meta-yocto-bsp \ 448 $HOME/poky/meta-yocto-bsp \
449 $HOME/poky/meta-mylayer \ 449 $HOME/poky/meta-mylayer \
450 " 450 "
451
452 BBLAYERS_NON_REMOVABLE ?= " \
453 $HOME/poky/meta \
454 $HOME/poky/meta-yocto \
455 "
456 </literallayout> 451 </literallayout>
457 </para> 452 </para>
458 453
@@ -879,11 +874,6 @@
879 /usr/local/src/yocto/meta-yocto-bsp \ 874 /usr/local/src/yocto/meta-yocto-bsp \
880 /usr/local/src/yocto/meta-mylayer \ 875 /usr/local/src/yocto/meta-mylayer \
881 " 876 "
882
883 BBLAYERS_NON_REMOVABLE ?= " \
884 /usr/local/src/yocto/meta \
885 /usr/local/src/yocto/meta-yocto \
886 "
887 </literallayout> 877 </literallayout>
888 Adding the layer to this file enables the build system to 878 Adding the layer to this file enables the build system to
889 locate the layer during the build. 879 locate the layer during the build.
@@ -5170,11 +5160,6 @@
5170 $HOME/poky/meta-yocto-bsp \ 5160 $HOME/poky/meta-yocto-bsp \
5171 $HOME/poky/meta-mylayer \ 5161 $HOME/poky/meta-mylayer \
5172 " 5162 "
5173
5174 BBLAYERS_NON_REMOVABLE ?= " \
5175 $HOME/poky/meta \
5176 $HOME/poky/meta-yocto \
5177 "
5178 </literallayout></para></listitem> 5163 </literallayout></para></listitem>
5179 </itemizedlist> 5164 </itemizedlist>
5180 </para> 5165 </para>
@@ -10038,11 +10023,6 @@
10038 ##OEROOT##/meta-yocto-bsp \ 10023 ##OEROOT##/meta-yocto-bsp \
10039 ##OEROOT##/meta-mylayer \ 10024 ##OEROOT##/meta-mylayer \
10040 " 10025 "
10041
10042 BBLAYERS_NON_REMOVABLE ?= " \
10043 ##OEROOT##/meta \
10044 ##OEROOT##/meta-yocto \
10045 "
10046 </literallayout> 10026 </literallayout>
10047 Creating and providing an archive of the 10027 Creating and providing an archive of the
10048 <link linkend='metadata'>Metadata</link> layers 10028 <link linkend='metadata'>Metadata</link> layers
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index bb75926932..91b2058544 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1669,8 +1669,8 @@
1669 <para> 1669 <para>
1670 A common development workflow consists of modifying project source 1670 A common development workflow consists of modifying project source
1671 files that are external to the Yocto Project and then integrating 1671 files that are external to the Yocto Project and then integrating
1672 that project's build output into an image built using the Yocto 1672 that project's build output into an image built using the
1673 Project. 1673 OpenEmbedded build system.
1674 Given this scenario, development engineers typically want to stick 1674 Given this scenario, development engineers typically want to stick
1675 to their familiar project development tools and methods, which allows 1675 to their familiar project development tools and methods, which allows
1676 them to just focus on the project. 1676 them to just focus on the project.
@@ -1679,7 +1679,7 @@
1679 <para> 1679 <para>
1680 Several workflows exist that allow you to develop, build, and test 1680 Several workflows exist that allow you to develop, build, and test
1681 code that is going to be integrated into an image built using the 1681 code that is going to be integrated into an image built using the
1682 Yocto Project. 1682 OpenEmbedded build system.
1683 This section describes two: 1683 This section describes two:
1684 <itemizedlist> 1684 <itemizedlist>
1685 <listitem><para><emphasis><filename>devtool</filename>:</emphasis> 1685 <listitem><para><emphasis><filename>devtool</filename>:</emphasis>
@@ -1715,7 +1715,7 @@
1715 <para> 1715 <para>
1716 As mentioned earlier, <filename>devtool</filename> helps 1716 As mentioned earlier, <filename>devtool</filename> helps
1717 you easily develop projects whose build output must be part of 1717 you easily develop projects whose build output must be part of
1718 an image built using the Yocto Project. 1718 an image built using the OpenEmbedded build system.
1719 The remainder of this section presents the workflow you would 1719 The remainder of this section presents the workflow you would
1720 use that includes <filename>devtool</filename>. 1720 use that includes <filename>devtool</filename>.
1721 <note> 1721 <note>
@@ -1770,9 +1770,9 @@
1770 Several opportunities exist in the workflow to extract and 1770 Several opportunities exist in the workflow to extract and
1771 work on the files. 1771 work on the files.
1772 For now, just realize that you need to be able to have 1772 For now, just realize that you need to be able to have
1773 access to and edit files in your layer. 1773 access to and edit files.
1774 One obvious solution is to initially extract the code into its 1774 One obvious solution is to initially extract the code into an
1775 own layer in preparation for modification. 1775 isolated area in preparation for modification.
1776 </para> 1776 </para>
1777 1777
1778 <para> 1778 <para>
@@ -1788,7 +1788,7 @@
1788 </section> 1788 </section>
1789 1789
1790 <section id='use-devtool-to-integrate-your-code-with-the-image'> 1790 <section id='use-devtool-to-integrate-your-code-with-the-image'>
1791 <title>Use <filename>dev-tool</filename> to Integrate Your Code with the Image</title> 1791 <title>Use <filename>devtool</filename> to Integrate Your Code with the Image</title>
1792 1792
1793 <para> 1793 <para>
1794 <filename>devtool</filename> automatically 1794 <filename>devtool</filename> automatically
@@ -1796,15 +1796,15 @@
1796 build system to build your code into the image. 1796 build system to build your code into the image.
1797 Use the following command form: 1797 Use the following command form:
1798 <literallayout class='monospaced'> 1798 <literallayout class='monospaced'>
1799 $ devtool add <replaceable>your-project-name</replaceable>&nbsp;<replaceable>path-to-source</replaceable>/<replaceable>your-project-name</replaceable> 1799 $ devtool add <replaceable>your-project-name</replaceable>&nbsp;<replaceable>path-to-source</replaceable>
1800 </literallayout> 1800 </literallayout>
1801 Running <filename>devtool</filename> modifies the 1801 Running <filename>devtool</filename> modifies the
1802 <filename>bblayers.conf</filename> used to build the 1802 <filename>bblayers.conf</filename> that the
1803 image in the Yocto Project. 1803 OpenEmbedded build system uses to build an image.
1804 For more information on the <filename>bblayers.conf</filename>, 1804 For more information on the <filename>bblayers.conf</filename>,
1805 see the 1805 see the
1806 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" 1806 "<ulink url='&YOCTO_DOCS_REF_URL;#structure-build-conf-bblayers.conf'><filename>build/conf/bblayers.conf</filename></ulink>"
1807 section in the Yocto Project Board Support Package (BSP) Developer's Guide. 1807 section in the Yocto Project Reference Manual.
1808 </para> 1808 </para>
1809 1809
1810 <para> 1810 <para>
@@ -1814,7 +1814,7 @@
1814 <literallayout class='monospaced'> 1814 <literallayout class='monospaced'>
1815 <replaceable>path-to-source</replaceable>/<replaceable>build-directory</replaceable>/<replaceable>workspace-layer</replaceable> 1815 <replaceable>path-to-source</replaceable>/<replaceable>build-directory</replaceable>/<replaceable>workspace-layer</replaceable>
1816 </literallayout> 1816 </literallayout>
1817 By default, the name of the workspace layer is "workplace". 1817 By default, the name of the workspace layer is "workspace".
1818 </para> 1818 </para>
1819 1819
1820 <para> 1820 <para>
@@ -1825,6 +1825,7 @@
1825 section. 1825 section.
1826 </para> 1826 </para>
1827 1827
1828<!--
1828 <para> 1829 <para>
1829 Of course, each layer must have a 1830 Of course, each layer must have a
1830 <filename>layer.conf</filename> configuration file. 1831 <filename>layer.conf</filename> configuration file.
@@ -1842,9 +1843,10 @@
1842 BBFILE_PRIORITY_workspacelayer = "99" 1843 BBFILE_PRIORITY_workspacelayer = "99"
1843 </literallayout> 1844 </literallayout>
1844 </para> 1845 </para>
1846-->
1845 1847
1846 <para> 1848 <para>
1847 Running <filename>devtool</filename> also automatically 1849 Running <filename>devtool</filename> automatically
1848 generates your recipe: 1850 generates your recipe:
1849 <literallayout class='monospaced'> 1851 <literallayout class='monospaced'>
1850 $ cat workspace/recipes/<replaceable>your-project-name</replaceable>/<replaceable>your-project-name</replaceable>.bb 1852 $ cat workspace/recipes/<replaceable>your-project-name</replaceable>/<replaceable>your-project-name</replaceable>.bb
@@ -1898,8 +1900,10 @@
1898 <literallayout class='monospaced'> 1900 <literallayout class='monospaced'>
1899 $ bitbake <replaceable>your-project-name</replaceable> 1901 $ bitbake <replaceable>your-project-name</replaceable>
1900 </literallayout> 1902 </literallayout>
1901 To use <filename>devtool</filename>, run the tool with the 1903 Alternatively, you can use
1902 <filename>build</filename> option: 1904 <filename>devtool build</filename>, which is equivalent to
1905 <filename>bitbake -c install</filename>.
1906 For example:
1903 <literallayout class='monospaced'> 1907 <literallayout class='monospaced'>
1904 $ devtool build <replaceable>your-project-name</replaceable> 1908 $ devtool build <replaceable>your-project-name</replaceable>
1905 </literallayout> 1909 </literallayout>
@@ -1913,11 +1917,9 @@
1913 The final step before testing is to rebuild the base image 1917 The final step before testing is to rebuild the base image
1914 with your project changes as part of the image. 1918 with your project changes as part of the image.
1915 Simply run BitBake again on your image. 1919 Simply run BitBake again on your image.
1916 Here is an example that assumes 1920 Here is an example:
1917 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
1918 is set to "qemux86":
1919 <literallayout class='monospaced'> 1921 <literallayout class='monospaced'>
1920 $ bitbake qemux86 <replaceable>image</replaceable> 1922 $ bitbake <replaceable>image</replaceable>
1921 </literallayout> 1923 </literallayout>
1922 </para> 1924 </para>
1923 </section> 1925 </section>
@@ -1958,35 +1960,32 @@
1958 <filename>--help</filename> option: 1960 <filename>--help</filename> option:
1959 <literallayout class='monospaced'> 1961 <literallayout class='monospaced'>
1960 $ devtool --help 1962 $ devtool --help
1961 usage: devtool [-h] [--basepath BASEPATH] [-d] [-q] 1963 usage: devtool [-h] [--basepath BASEPATH] [-d] [-q] [--color COLOR]
1962 [--color {auto,always,never}] 1964 &lt;subcommand&gt; ...
1963 {create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset}
1964 ...
1965 1965
1966 OpenEmbedded development tool 1966 OpenEmbedded development tool
1967 1967
1968 positional arguments:
1969 {create-workspace,deploy-target,undeploy-target,add,modify,extract,update-recipe,status,build,reset}
1970 create-workspace Set up a workspace
1971 deploy-target Deploy recipe output files to live target machine
1972 undeploy-target Undeploy recipe output files in live target machine
1973 add Add a new recipe
1974 modify Modify the source for an existing recipe
1975 extract Extract the source for an existing recipe
1976 update-recipe Apply changes from external source tree to recipe
1977 status Show status
1978 build Build recipe
1979 reset Remove a recipe from your workspace
1980
1981 optional arguments: 1968 optional arguments:
1982 -h, --help show this help message and exit 1969 -h, --help show this help message and exit
1983 --basepath BASEPATH Base directory of SDK / build directory 1970 --basepath BASEPATH Base directory of SDK / build directory
1984 -d, --debug Enable debug output 1971 -d, --debug Enable debug output
1985 -q, --quiet Print only errors 1972 -q, --quiet Print only errors
1986 --color {auto,always,never} 1973 --color COLOR Colorize output (where COLOR is auto, always, never)
1987 Colorize output 1974
1988 1975 subcommands:
1989 Use devtool &lt;command&gt; --help to get help on a specific command 1976 &lt;subcommand&gt;
1977 create-workspace Set up a workspace
1978 deploy-target Deploy recipe output files to live target machine
1979 undeploy-target Undeploy recipe output files in live target machine
1980 add Add a new recipe
1981 modify Modify the source for an existing recipe
1982 extract Extract the source for an existing recipe
1983 update-recipe Apply changes from external source tree to recipe
1984 status Show workspace status
1985 build Build a recipe
1986 reset Remove a recipe from your workspace
1987
1988 Use devtool &lt;subcommand&gt; --help to get help on a specific command
1990 </literallayout> 1989 </literallayout>
1991 </para> 1990 </para>
1992 1991
@@ -1996,7 +1995,9 @@
1996 name and using <filename>--help</filename>: 1995 name and using <filename>--help</filename>:
1997 <literallayout class='monospaced'> 1996 <literallayout class='monospaced'>
1998 $ devtool add --help 1997 $ devtool add --help
1999 usage: devtool add [-h] [--version VERSION] recipename srctree 1998 usage: devtool add [-h] [--same-dir] [--version VERSION] recipename srctree
1999
2000 Adds a new recipe
2000 2001
2001 positional arguments: 2002 positional arguments:
2002 recipename Name for new recipe to add 2003 recipename Name for new recipe to add
@@ -2004,7 +2005,9 @@
2004 2005
2005 optional arguments: 2006 optional arguments:
2006 -h, --help show this help message and exit 2007 -h, --help show this help message and exit
2008 --same-dir, -s Build in same directory as source (default: False)
2007 --version VERSION, -V VERSION 2009 --version VERSION, -V VERSION
2010 Version to use within recipe (PV) (default: None)
2008 </literallayout> 2011 </literallayout>
2009 </para> 2012 </para>
2010 </section> 2013 </section>
@@ -2013,7 +2016,7 @@
2013 <title>Adding a New Recipe to the Workspace Layer</title> 2016 <title>Adding a New Recipe to the Workspace Layer</title>
2014 2017
2015 <para> 2018 <para>
2016 Use the <filename>add</filename> command to add a new recipe 2019 Use the <filename>devtool add</filename> command to add a new recipe
2017 to the workspace layer. 2020 to the workspace layer.
2018 The recipe you add should not exist - 2021 The recipe you add should not exist -
2019 <filename>devtool</filename> creates it for you. 2022 <filename>devtool</filename> creates it for you.
@@ -2072,7 +2075,7 @@
2072 <title>Creating the Workspace Layer</title> 2075 <title>Creating the Workspace Layer</title>
2073 2076
2074 <para> 2077 <para>
2075 Use the <filename>create-workspace</filename> command to 2078 Use the <filename>devtool create-workspace</filename> command to
2076 create a new workspace layer in your 2079 create a new workspace layer in your
2077 <link linkend='build-directory'>Build Directory</link>. 2080 <link linkend='build-directory'>Build Directory</link>.
2078 When you create a new workspace layer, it is populated with the 2081 When you create a new workspace layer, it is populated with the
@@ -2108,19 +2111,21 @@
2108 <title>Modifying a Recipe</title> 2111 <title>Modifying a Recipe</title>
2109 2112
2110 <para> 2113 <para>
2111 Use the <filename>modify</filename> command to configure 2114 Use the <filename>devtool modify</filename> command to begin
2112 an external recipe in the workspace layer. 2115 modifying the source of an existing recipe.
2113 This command is very similar to the 2116 This command is very similar to the
2114 <link linkend='devtool-adding-a-new-recipe-to-the-workspace'><filename>add</filename></link> 2117 <link linkend='devtool-adding-a-new-recipe-to-the-workspace'><filename>add</filename></link>
2115 command except that it does not physically create the 2118 command except that it does not physically create the
2116 recipe in the workspace layer because the recipe already 2119 recipe in the workspace layer because the recipe already
2117 exists in an external layer. 2120 exists in an another layer.
2118 </para> 2121 </para>
2119 2122
2120 <para> 2123 <para>
2121 The <filename>modify</filename> command provides options 2124 The <filename>devtool modify</filename> command extracts the
2122 that allow you to extract the source and provide a 2125 source for a recipe, sets it up as a Git repository if the
2123 development branch name where you can do your work. 2126 source had not already been fetched from Git, checks out a
2127 branch for development, and applies any patches from the recipe
2128 as commits on top.
2124 You can use the following command to checkout the source 2129 You can use the following command to checkout the source
2125 files: 2130 files:
2126 <literallayout class='monospaced'> 2131 <literallayout class='monospaced'>
@@ -2148,15 +2153,23 @@
2148 <title>Resetting a Recipe</title> 2153 <title>Resetting a Recipe</title>
2149 2154
2150 <para> 2155 <para>
2151 Use the <filename>reset</filename> command to remove a 2156 Use the <filename>devtool reset</filename> command to remove a
2152 recipe and its configuration (e.g. the corresponding 2157 recipe and its configuration (e.g. the corresponding
2153 <filename>.bbappend</filename> file) from the workspace layer. 2158 <filename>.bbappend</filename> file) from the workspace layer.
2154 Realize that this command deletes the recipe and and the 2159 Realize that this command deletes the recipe and the
2155 append file. 2160 append file.
2156 The command does not physically move them for you. 2161 The command does not physically move them for you.
2157 Consequently, you must be sure to physically relocate your 2162 Consequently, you must be sure to physically relocate your
2158 updated recipe and the append file outside of the workspace 2163 updated recipe and the append file outside of the workspace
2159 layer before running the <filename>reset</filename> command. 2164 layer before running the <filename>devtool reset</filename>
2165 command.
2166 </para>
2167
2168 <para>
2169 If the <filename>devtool reset</filename> command detects that
2170 the recipe or the append files have been modified, the
2171 command preserves the modified files in a separate "attic"
2172 subdirectory under the workspace layer.
2160 <note> 2173 <note>
2161 For complete syntax, use the 2174 For complete syntax, use the
2162 <filename>devtool reset --help</filename> command. 2175 <filename>devtool reset --help</filename> command.
@@ -2168,18 +2181,17 @@
2168 <title>Updating a Recipe</title> 2181 <title>Updating a Recipe</title>
2169 2182
2170 <para> 2183 <para>
2171 Use the <filename>update-recipe</filename> command to cause 2184 Use the <filename>devtool update-recipe</filename> command to
2172 <filename>devtool</filename> to update your recipe with patches 2185 cause <filename>devtool</filename> to update your recipe with
2173 that reflect changes you make to the source files. 2186 patches that reflect changes you make to the source files.
2174 For example, if you know you are going to work on some 2187 For example, if you know you are going to work on some
2175 code, you could first use the 2188 code, you could first use the
2176 <link linkend='devtool-modifying-a-recipe'><filename>modify</filename></link> 2189 <link linkend='devtool-modifying-a-recipe'><filename>devtool modify</filename></link>
2177 command to extract the code and set up the workspace. 2190 command to extract the code and set up the workspace.
2178 After which, you could modify, compile, and test the code 2191 After which, you could modify, compile, and test the code.
2179 in its own layer to which it was extracted.
2180 When you are satisfied with the results you can then 2192 When you are satisfied with the results you can then
2181 run the <filename>update-recipe</filename> to create the 2193 run the <filename>devtool update-recipe</filename> to create the
2182 patches and update the recipe in the external layer: 2194 patches and update the recipe:
2183 <literallayout class='monospaced'> 2195 <literallayout class='monospaced'>
2184 $ devtool update-recipe <replaceable>recipe</replaceable> 2196 $ devtool update-recipe <replaceable>recipe</replaceable>
2185 </literallayout> 2197 </literallayout>
@@ -2194,9 +2206,12 @@
2194 <title>Building Your Software</title> 2206 <title>Building Your Software</title>
2195 2207
2196 <para> 2208 <para>
2197 Use the <filename>build</filename> command to cause the 2209 Use the <filename>devtool build</filename> command to cause the
2198 OpenEmbedded build system to build your software based 2210 OpenEmbedded build system to build your software based
2199 on the recipe file: 2211 on the recipe file.
2212 The <filename>devtool build</filename> command is equivalent to
2213 <filename>bitbake -c install</filename>.
2214 Here is an example:
2200 <literallayout class='monospaced'> 2215 <literallayout class='monospaced'>
2201 $ devtool build <replaceable>recipe</replaceable> 2216 $ devtool build <replaceable>recipe</replaceable>
2202 </literallayout> 2217 </literallayout>
@@ -2204,8 +2219,8 @@
2204 For complete syntax, use the 2219 For complete syntax, use the
2205 <filename>devtool update-recipe --help</filename> command. 2220 <filename>devtool update-recipe --help</filename> command.
2206 </note> 2221 </note>
2207 Building your software using <filename>build</filename> is 2222 Building your software using <filename>devtool build</filename>
2208 identical to using BitBake to build the software. 2223 is identical to using BitBake to build the software.
2209 </para> 2224 </para>
2210 </section> 2225 </section>
2211 2226
@@ -2213,17 +2228,36 @@
2213 <title>Deploying Your Software on the Target Machine</title> 2228 <title>Deploying Your Software on the Target Machine</title>
2214 2229
2215 <para> 2230 <para>
2216 Use the <filename>deploy-target</filename> command to deploy 2231 Use the <filename>devtool deploy-target</filename> command to
2217 the recipe's build output to the the live target machine: 2232 deploy the recipe's build output to the live target machine:
2218 <literallayout class='monospaced'> 2233 <literallayout class='monospaced'>
2219 $ devtool deploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable> 2234 $ devtool deploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable>
2220 </literallayout> 2235 </literallayout>
2221 The <replaceable>target</replaceable> is the actual 2236 The <replaceable>target</replaceable> is the address of the
2222 target running on an SSH server (i.e. 2237 target machine, which must be running an SSH server (i.e.
2223 <filename>user@hostname[:destdir]</filename>. 2238 <filename>user@hostname[:destdir]</filename>).
2224 <note> 2239 </para>
2225 For complete syntax, use the 2240
2226 <filename>devtool deploy-target --help</filename> command. 2241 <para>
2242 This command deploys all files installed during the
2243 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>
2244 task.
2245 Furthermore, you do not need to have package management enabled
2246 within the target machine.
2247 If you do, the package manager is bypassed.
2248 <note><title>Notes</title>
2249 <para>
2250 The <filename>deploy-target</filename>
2251 functionality is for development only.
2252 You should never use it to update an image that will be
2253 used in production.
2254 </para>
2255
2256 <para>
2257 For complete syntax, use the
2258 <filename>devtool deploy-target --help</filename>
2259 command.
2260 </para>
2227 </note> 2261 </note>
2228 </para> 2262 </para>
2229 </section> 2263 </section>
@@ -2232,18 +2266,18 @@
2232 <title>Removing Your Software from the Target Machine</title> 2266 <title>Removing Your Software from the Target Machine</title>
2233 2267
2234 <para> 2268 <para>
2235 Use the <filename>undeploy-target</filename> command to remove 2269 Use the <filename>devtool undeploy-target</filename> command to
2236 deployed build output from the target machine. 2270 remove deployed build output from the target machine.
2237 For <filename>undeploy-target</filename> command to work, 2271 For the <filename>devtool undeploy-target</filename> command to
2238 you must have previously used the 2272 work, you must have previously used the
2239 <link linkend='devtool-deploying-your-software-on-the-target-machine'><filename>deploy-target</filename></link> 2273 <link linkend='devtool-deploying-your-software-on-the-target-machine'><filename>devtool deploy-target</filename></link>
2240 command. 2274 command.
2241 <literallayout class='monospaced'> 2275 <literallayout class='monospaced'>
2242 $ devtool undeploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable> 2276 $ devtool undeploy-target <replaceable>recipe</replaceable>&nbsp;<replaceable>target</replaceable>
2243 </literallayout> 2277 </literallayout>
2244 The <replaceable>target</replaceable> is the actual 2278 The <replaceable>target</replaceable> is the address of the
2245 target running on an SSH server (i.e. 2279 target machine, which must be running an SSH server (i.e.
2246 <filename>user@hostname</filename>. 2280 <filename>user@hostname</filename>).
2247 <note> 2281 <note>
2248 For complete syntax, use the 2282 For complete syntax, use the
2249 <filename>devtool undeploy-target --help</filename> command. 2283 <filename>devtool undeploy-target --help</filename> command.
@@ -2257,11 +2291,19 @@
2257 2291
2258 <para> 2292 <para>
2259 <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> 2293 <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink>
2260 is a powerful tool that allows you to capture source code changes without having 2294 is a powerful tool that allows you to capture source code changes
2261 a clean source tree. 2295 without having a clean source tree.
2262 This section outlines the typical workflow you can use to modify 2296 This section outlines the typical workflow you can use to modify
2263 source code, test changes, and then preserve the changes in the 2297 source code, test changes, and then preserve the changes in the
2264 form of a patch all using Quilt. 2298 form of a patch all using Quilt.
2299 <note><title>Tip</title>
2300 With regard to preserving changes to source files if you
2301 clean a recipe or have <filename>rm_work</filename> enabled,
2302 the workflow described in the
2303 "<link linkend='using-devtool-in-your-workflow'>Using <filename>devtool</filename> in Your Workflow</link>"
2304 section is a safer development flow than than the flow that
2305 uses Quilt.
2306 </note>
2265 </para> 2307 </para>
2266 2308
2267 <para> 2309 <para>