diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 58 |
1 files changed, 32 insertions, 26 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index aa52c2c00a..a62c67d968 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
| @@ -1683,10 +1683,8 @@ | |||
| 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> |
| 1686 | A set of tools and | 1686 | A set of tools to aid in working on the source code built by |
| 1687 | enhancements put together by the Yocto Project team that | 1687 | the OpenEmbedded build system. |
| 1688 | makes it easier for you to modify code that is external to | ||
| 1689 | the Yocto Project. | ||
| 1690 | Section | 1688 | Section |
| 1691 | "<link linkend='using-devtool-in-your-workflow'>Using <filename>devtool</filename> in Your Workflow</link>" | 1689 | "<link linkend='using-devtool-in-your-workflow'>Using <filename>devtool</filename> in Your Workflow</link>" |
| 1692 | describes this workflow. | 1690 | describes this workflow. |
| @@ -1739,9 +1737,6 @@ | |||
| 1739 | <title>Establish the Reference Image</title> | 1737 | <title>Establish the Reference Image</title> |
| 1740 | 1738 | ||
| 1741 | <para> | 1739 | <para> |
| 1742 | Local repositories for both the Yocto Project and your | ||
| 1743 | project must exist in addition to the image built by | ||
| 1744 | the OpenEmbedded build system. | ||
| 1745 | The steps to clone the <filename>poky</filename> Git | 1740 | The steps to clone the <filename>poky</filename> Git |
| 1746 | repository, build out an image, and test it using QEMU | 1741 | repository, build out an image, and test it using QEMU |
| 1747 | are well documented as follows: | 1742 | are well documented as follows: |
| @@ -1786,29 +1781,37 @@ | |||
| 1786 | </para> | 1781 | </para> |
| 1787 | 1782 | ||
| 1788 | <para> | 1783 | <para> |
| 1789 | Another option is to use the <filename>devtool</filename> | 1784 | Another option is to use the |
| 1790 | command. | 1785 | <filename>devtool modify</filename> command. |
| 1791 | <filename>devtool</filename> makes use of a | 1786 | This command makes use of a "workspace" layer where much of |
| 1792 | "workspace" layer where much of the transitional work | 1787 | the transitional work occurs, which is needed for setting up |
| 1793 | occurs, which is needed for setting up Metadata used by the | 1788 | Metadata used by the OpenEmbedded build system that lets you |
| 1794 | OpenEmbedded build system that lets you build your software. | 1789 | build your software. |
| 1795 | Options exist using <filename>devtool</filename> that | 1790 | Options (i.e. "-x") exist using <filename>devtool</filename> |
| 1796 | enable you to use the tool to extract source code. | 1791 | that enable you to use the tool to extract source code. |
| 1797 | </para> | 1792 | </para> |
| 1798 | </section> | 1793 | </section> |
| 1799 | 1794 | ||
| 1800 | <section id='use-devtool-to-integrate-your-code-with-the-image'> | 1795 | <section id='use-devtool-to-integrate-your-code-with-the-image'> |
| 1801 | <title>Use <filename>devtool</filename> to Integrate Your Code with the Image</title> | 1796 | <title>Use <filename>devtool add</filename> to Integrate Your Code with the Image</title> |
| 1802 | 1797 | ||
| 1803 | <para> | 1798 | <para> |
| 1804 | <filename>devtool</filename> automatically | 1799 | The <filename>devtool add</filename> command automatically |
| 1805 | generates the needed Metadata that allows the OpenEmbedded | 1800 | generates the needed Metadata that allows the OpenEmbedded |
| 1806 | build system to build your code into the image. | 1801 | build system to build your code into the image. |
| 1802 | <note> | ||
| 1803 | If a package or packages produced by the recipe on which | ||
| 1804 | you are working are not already in | ||
| 1805 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink> | ||
| 1806 | for the image, you must add them. | ||
| 1807 | The <filename>devtool add</filename> command does not | ||
| 1808 | add them for you. | ||
| 1809 | </note> | ||
| 1807 | Use the following command form: | 1810 | Use the following command form: |
| 1808 | <literallayout class='monospaced'> | 1811 | <literallayout class='monospaced'> |
| 1809 | $ devtool add <replaceable>your-project-name</replaceable> <replaceable>path-to-source</replaceable> | 1812 | $ devtool add <replaceable>your-project-name</replaceable> <replaceable>path-to-source</replaceable> |
| 1810 | </literallayout> | 1813 | </literallayout> |
| 1811 | Running <filename>devtool</filename> modifies the | 1814 | Running <filename>devtool add</filename> modifies the |
| 1812 | <filename>bblayers.conf</filename> that the | 1815 | <filename>bblayers.conf</filename> that the |
| 1813 | OpenEmbedded build system uses to build an image. | 1816 | OpenEmbedded build system uses to build an image. |
| 1814 | For more information on the <filename>bblayers.conf</filename>, | 1817 | For more information on the <filename>bblayers.conf</filename>, |
| @@ -1818,7 +1821,7 @@ | |||
| 1818 | </para> | 1821 | </para> |
| 1819 | 1822 | ||
| 1820 | <para> | 1823 | <para> |
| 1821 | Running <filename>devtool</filename> adds a new workspace | 1824 | Running <filename>devtool add</filename> adds a new workspace |
| 1822 | layer to the <filename>bblayers.conf</filename> file that | 1825 | layer to the <filename>bblayers.conf</filename> file that |
| 1823 | is based on your project's location: | 1826 | is based on your project's location: |
| 1824 | <literallayout class='monospaced'> | 1827 | <literallayout class='monospaced'> |
| @@ -1856,7 +1859,7 @@ | |||
| 1856 | --> | 1859 | --> |
| 1857 | 1860 | ||
| 1858 | <para> | 1861 | <para> |
| 1859 | Running <filename>devtool</filename> automatically | 1862 | Running <filename>devtool add</filename> automatically |
| 1860 | generates your recipe: | 1863 | generates your recipe: |
| 1861 | <literallayout class='monospaced'> | 1864 | <literallayout class='monospaced'> |
| 1862 | $ cat workspace/recipes/<replaceable>your-project-name</replaceable>/<replaceable>your-project-name</replaceable>.bb | 1865 | $ cat workspace/recipes/<replaceable>your-project-name</replaceable>/<replaceable>your-project-name</replaceable>.bb |
| @@ -1885,7 +1888,7 @@ | |||
| 1885 | </para> | 1888 | </para> |
| 1886 | 1889 | ||
| 1887 | <para> | 1890 | <para> |
| 1888 | Lastly, the <filename>devtool</filename> creates the | 1891 | Lastly, the <filename>devtool add</filename> command creates the |
| 1889 | <filename>.bbappend</filename> file: | 1892 | <filename>.bbappend</filename> file: |
| 1890 | <literallayout class='monospaced'> | 1893 | <literallayout class='monospaced'> |
| 1891 | $ cat workspace/appends/<replaceable>your-project-name</replaceable>.bbappend | 1894 | $ cat workspace/appends/<replaceable>your-project-name</replaceable>.bbappend |
| @@ -1901,8 +1904,8 @@ | |||
| 1901 | <title>Build Your Project</title> | 1904 | <title>Build Your Project</title> |
| 1902 | 1905 | ||
| 1903 | <para> | 1906 | <para> |
| 1904 | You can use BitBake or <filename>devtool</filename> to build | 1907 | You can use BitBake or <filename>devtool build</filename> to |
| 1905 | your modified project. | 1908 | build your modified project. |
| 1906 | </para> | 1909 | </para> |
| 1907 | 1910 | ||
| 1908 | <para> | 1911 | <para> |
| @@ -2063,7 +2066,8 @@ | |||
| 2063 | README - Provides information on what is in workspace layer and how to | 2066 | README - Provides information on what is in workspace layer and how to |
| 2064 | manage it. | 2067 | manage it. |
| 2065 | 2068 | ||
| 2066 | appends - A directory that contains *.bbappend files. | 2069 | appends - A directory that contains *.bbappend files, which point to |
| 2070 | external source. | ||
| 2067 | 2071 | ||
| 2068 | conf - A configuration directory that contains the layer.conf file. | 2072 | conf - A configuration directory that contains the layer.conf file. |
| 2069 | 2073 | ||
| @@ -2078,6 +2082,8 @@ | |||
| 2078 | Running <filename>devtool add</filename> when the | 2082 | Running <filename>devtool add</filename> when the |
| 2079 | workspace layer exists causes the tool to add the recipe | 2083 | workspace layer exists causes the tool to add the recipe |
| 2080 | and append files into the existing workspace layer. | 2084 | and append files into the existing workspace layer. |
| 2085 | The <filename>.bbappend</filename> file is created to point | ||
| 2086 | to the external source tree. | ||
| 2081 | </para> | 2087 | </para> |
| 2082 | </section> | 2088 | </section> |
| 2083 | 2089 | ||
| @@ -2192,8 +2198,8 @@ | |||
| 2192 | 2198 | ||
| 2193 | <para> | 2199 | <para> |
| 2194 | Use the <filename>devtool update-recipe</filename> command to | 2200 | Use the <filename>devtool update-recipe</filename> command to |
| 2195 | cause <filename>devtool</filename> to update your recipe with | 2201 | update your recipe with patches that reflect changes you make |
| 2196 | patches that reflect changes you make to the source files. | 2202 | to the source files. |
| 2197 | For example, if you know you are going to work on some | 2203 | For example, if you know you are going to work on some |
| 2198 | code, you could first use the | 2204 | code, you could first use the |
| 2199 | <link linkend='devtool-modifying-a-recipe'><filename>devtool modify</filename></link> | 2205 | <link linkend='devtool-modifying-a-recipe'><filename>devtool modify</filename></link> |
