diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 27 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 35 |
2 files changed, 48 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 77c14a6611..1245345cc4 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -431,12 +431,27 @@ | |||
| 431 | <filename>poky</filename> repository or any supported BSP tarballs. | 431 | <filename>poky</filename> repository or any supported BSP tarballs. |
| 432 | Unpacking these tarballs gives you a snapshot of the released | 432 | Unpacking these tarballs gives you a snapshot of the released |
| 433 | files. | 433 | files. |
| 434 | <note> | 434 | <note><title>Notes</title> |
| 435 | The recommended method for setting up the Yocto Project | 435 | <itemizedlist> |
| 436 | <link linkend='source-directory'>Source Directory</link> and the | 436 | <listitem><para> |
| 437 | files for supported BSPs (e.g., <filename>meta-intel</filename>) is to | 437 | The recommended method for setting up the Yocto Project |
| 438 | use <link linkend='git'>Git</link> to create a local copy of the | 438 | <link linkend='source-directory'>Source Directory</link> |
| 439 | upstream repositories. | 439 | and the files for supported BSPs |
| 440 | (e.g., <filename>meta-intel</filename>) is to use | ||
| 441 | <link linkend='git'>Git</link> to create a local copy of | ||
| 442 | the upstream repositories. | ||
| 443 | </para></listitem> | ||
| 444 | <listitem><para> | ||
| 445 | Be sure to always work in matching branches for both | ||
| 446 | the <filename>meta-intel</filename> repository and the | ||
| 447 | <link linkend='source-directory'>Source Directory</link> | ||
| 448 | (i.e. <filename>poky</filename>) repository. | ||
| 449 | For example, if you have checked out the "master" branch | ||
| 450 | of <filename>poky</filename> and you are going to use | ||
| 451 | <filename>meta-intel</filename>, be sure to checkout the | ||
| 452 | "master" branch of <filename>meta-intel</filename>. | ||
| 453 | </para></listitem> | ||
| 454 | </itemizedlist> | ||
| 440 | </note> | 455 | </note> |
| 441 | </para> | 456 | </para> |
| 442 | 457 | ||
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index deea5a7610..6ab93f79cf 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -187,8 +187,7 @@ | |||
| 187 | Receiving objects: 100% (727/727), 536.36 KiB | 240 KiB/s, done. | 187 | Receiving objects: 100% (727/727), 536.36 KiB | 240 KiB/s, done. |
| 188 | Resolving deltas: 100% (260/260), done. | 188 | Resolving deltas: 100% (260/260), done. |
| 189 | </literallayout></para></listitem> | 189 | </literallayout></para></listitem> |
| 190 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board | 190 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board Support Packages (BSPs):</emphasis> |
| 191 | Support Packages (BSPs):</emphasis> | ||
| 192 | The Yocto Project provides a layer called | 191 | The Yocto Project provides a layer called |
| 193 | <filename>meta-intel</filename> and it is maintained in its own | 192 | <filename>meta-intel</filename> and it is maintained in its own |
| 194 | separate Git repository. | 193 | separate Git repository. |
| @@ -196,6 +195,7 @@ | |||
| 196 | supported | 195 | supported |
| 197 | <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>. | 196 | <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>. |
| 198 | </para> | 197 | </para> |
| 198 | |||
| 199 | <para>The Yocto Project uses the following BSP layer naming | 199 | <para>The Yocto Project uses the following BSP layer naming |
| 200 | scheme: | 200 | scheme: |
| 201 | <literallayout class='monospaced'> | 201 | <literallayout class='monospaced'> |
| @@ -212,12 +212,18 @@ | |||
| 212 | See the | 212 | See the |
| 213 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" | 213 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
| 214 | section in the Yocto Project Board Support Package (BSP) | 214 | section in the Yocto Project Board Support Package (BSP) |
| 215 | Developer's Guide for more information on BSP Layers.</para> | 215 | Developer's Guide for more information on BSP Layers. |
| 216 | <para>You can locate the <filename>meta-intel</filename> Git | 216 | </para> |
| 217 | |||
| 218 | <para> | ||
| 219 | You can locate the <filename>meta-intel</filename> Git | ||
| 217 | repository in the "Yocto Metadata Layers" area of the Yocto | 220 | repository in the "Yocto Metadata Layers" area of the Yocto |
| 218 | Project Source Repositories at | 221 | Project Source Repositories at |
| 219 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> | 222 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
| 220 | <para>Using | 223 | </para> |
| 224 | |||
| 225 | <para> | ||
| 226 | Using | ||
| 221 | <link linkend='git'>Git</link> to create a local clone of the | 227 | <link linkend='git'>Git</link> to create a local clone of the |
| 222 | upstream repository can be helpful if you are working with | 228 | upstream repository can be helpful if you are working with |
| 223 | BSPs. | 229 | BSPs. |
| @@ -225,6 +231,16 @@ | |||
| 225 | Git repository inside the Source Directory. | 231 | Git repository inside the Source Directory. |
| 226 | For example, the following transcript shows the steps to clone | 232 | For example, the following transcript shows the steps to clone |
| 227 | <filename>meta-intel</filename>. | 233 | <filename>meta-intel</filename>. |
| 234 | <note> | ||
| 235 | Be sure to work in the <filename>meta-intel</filename> | ||
| 236 | branch that matches your | ||
| 237 | <link linkend='source-directory'>Source Directory</link> | ||
| 238 | (i.e. <filename>poky</filename>) branch. | ||
| 239 | For example, if you have checked out the "master" branch | ||
| 240 | of <filename>poky</filename> and you are going to use | ||
| 241 | <filename>meta-intel</filename>, be sure to checkout the | ||
| 242 | "master" branch of <filename>meta-intel</filename>. | ||
| 243 | </note> | ||
| 228 | <literallayout class='monospaced'> | 244 | <literallayout class='monospaced'> |
| 229 | $ cd ~/poky | 245 | $ cd ~/poky |
| 230 | $ git clone git://git.yoctoproject.org/meta-intel.git | 246 | $ git clone git://git.yoctoproject.org/meta-intel.git |
| @@ -234,8 +250,11 @@ | |||
| 234 | remote: Total 8844 (delta 4931), reused 8780 (delta 4867) | 250 | remote: Total 8844 (delta 4931), reused 8780 (delta 4867) |
| 235 | Receiving objects: 100% (8844/8844), 2.48 MiB | 264 KiB/s, done. | 251 | Receiving objects: 100% (8844/8844), 2.48 MiB | 264 KiB/s, done. |
| 236 | Resolving deltas: 100% (4931/4931), done. | 252 | Resolving deltas: 100% (4931/4931), done. |
| 237 | </literallayout></para> | 253 | </literallayout> |
| 238 | <para>The same | 254 | </para> |
| 255 | |||
| 256 | <para> | ||
| 257 | The same | ||
| 239 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink> | 258 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink> |
| 240 | referenced earlier covers how to set up the | 259 | referenced earlier covers how to set up the |
| 241 | <filename>meta-intel</filename> Git repository. | 260 | <filename>meta-intel</filename> Git repository. |
