diff options
| -rw-r--r-- | documentation/bsp-guide/bsp-guide.xml | 9 | ||||
| -rw-r--r-- | documentation/bsp-guide/bsp.xml | 36 |
2 files changed, 23 insertions, 22 deletions
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 642a52b01c..360166d031 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 3 | 4 | ||
| 4 | <book id='bsp-guide' lang='en' | 5 | <book id='bsp-guide' lang='en' |
| 5 | xmlns:xi="http://www.w3.org/2003/XInclude" | 6 | xmlns:xi="http://www.w3.org/2003/XInclude" |
| @@ -58,7 +59,7 @@ | |||
| 58 | </revhistory> | 59 | </revhistory> |
| 59 | 60 | ||
| 60 | <copyright> | 61 | <copyright> |
| 61 | <year>2010-2012</year> | 62 | <year>©RIGHT_YEAR;</year> |
| 62 | <holder>Linux Foundation</holder> | 63 | <holder>Linux Foundation</holder> |
| 63 | </copyright> | 64 | </copyright> |
| 64 | 65 | ||
| @@ -70,9 +71,9 @@ | |||
| 70 | <note> | 71 | <note> |
| 71 | Due to production processes, there could be differences between the Yocto Project | 72 | Due to production processes, there could be differences between the Yocto Project |
| 72 | documentation bundled in the release tarball and the | 73 | documentation bundled in the release tarball and the |
| 73 | <ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html'> | 74 | <ulink url='&YOCTO_DOCS_BSP_URL;'> |
| 74 | Board Support Package (BSP) Developer's Guide</ulink> on | 75 | Board Support Package (BSP) Developer's Guide</ulink> on |
| 75 | the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. | 76 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. |
| 76 | For the latest version of this manual, see the manual on the website. | 77 | For the latest version of this manual, see the manual on the website. |
| 77 | </note> | 78 | </note> |
| 78 | </legalnotice> | 79 | </legalnotice> |
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 35dae930f9..a49c0bef0b 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 3 | 4 | ||
| 4 | <chapter id='bsp'> | 5 | <chapter id='bsp'> |
| 5 | 6 | ||
| @@ -18,7 +19,7 @@ | |||
| 18 | </para> | 19 | </para> |
| 19 | 20 | ||
| 20 | <para> | 21 | <para> |
| 21 | This section (or document if you are reading the BSP Developer's Guide) defines | 22 | This chapter (or document if you are reading the BSP Developer's Guide) defines |
| 22 | a structure for these components | 23 | a structure for these components |
| 23 | so that BSPs follow a commonly understood layout. | 24 | so that BSPs follow a commonly understood layout. |
| 24 | Providing a common form allows end-users to understand and become familiar | 25 | Providing a common form allows end-users to understand and become familiar |
| @@ -30,10 +31,10 @@ | |||
| 30 | <note> | 31 | <note> |
| 31 | The information here does not provide an example of how to create a BSP. | 32 | The information here does not provide an example of how to create a BSP. |
| 32 | For examples on how to create a BSP, see the | 33 | For examples on how to create a BSP, see the |
| 33 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" | 34 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-bsp-appendix'>BSP Development Example</ulink>" |
| 34 | section in The Yocto Project Development Manual. | 35 | section in The Yocto Project Development Manual. |
| 35 | You can also see the | 36 | You can also see the |
| 36 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> | 37 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> |
| 37 | wiki page</ulink>. | 38 | wiki page</ulink>. |
| 38 | </note> | 39 | </note> |
| 39 | 40 | ||
| @@ -77,7 +78,7 @@ | |||
| 77 | <para> | 78 | <para> |
| 78 | The Yocto Project organizes BSP Layers within the Yocto Metadata Layers area | 79 | The Yocto Project organizes BSP Layers within the Yocto Metadata Layers area |
| 79 | of the Yocto Project Source Repositories at | 80 | of the Yocto Project Source Repositories at |
| 80 | <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>. | 81 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
| 81 | If you examine the source repositories, you will find many BSP Layers. | 82 | If you examine the source repositories, you will find many BSP Layers. |
| 82 | Here are a few: | 83 | Here are a few: |
| 83 | <literallayout class='monospaced'> | 84 | <literallayout class='monospaced'> |
| @@ -105,7 +106,7 @@ | |||
| 105 | of the BSP Layer. | 106 | of the BSP Layer. |
| 106 | This root is what you add to the <filename>BBLAYERS</filename> | 107 | This root is what you add to the <filename>BBLAYERS</filename> |
| 107 | variable in the <filename>conf/bblayers.conf</filename> file found in the | 108 | variable in the <filename>conf/bblayers.conf</filename> file found in the |
| 108 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'>Yocto Project Build Directory</ulink>. | 109 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project Build Directory</ulink>. |
| 109 | Adding the root allows the Yocto Project build system to recognize the BSP | 110 | Adding the root allows the Yocto Project build system to recognize the BSP |
| 110 | definition and from it build an image. | 111 | definition and from it build an image. |
| 111 | Here is an example: | 112 | Here is an example: |
| @@ -120,11 +121,10 @@ | |||
| 120 | 121 | ||
| 121 | <para> | 122 | <para> |
| 122 | For more detailed information on layers, see the | 123 | For more detailed information on layers, see the |
| 123 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 124 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
| 124 | section of the Yocto Project Development Manual. | 125 | section of the Yocto Project Development Manual. |
| 125 | You can also see the detailed examples in the appendices of | 126 | You can also see the detailed examples in the appendices of |
| 126 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'> | 127 | <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project Development Manual</ulink>. |
| 127 | The Yocto Project Development Manual</ulink>. | ||
| 128 | </para> | 128 | </para> |
| 129 | </section> | 129 | </section> |
| 130 | 130 | ||
| @@ -276,7 +276,7 @@ | |||
| 276 | images appropriate to the target system. | 276 | images appropriate to the target system. |
| 277 | This directory typically contains graphical (e.g. sato) and minimal live images | 277 | This directory typically contains graphical (e.g. sato) and minimal live images |
| 278 | when the BSP tarball has been created and made available in the | 278 | when the BSP tarball has been created and made available in the |
| 279 | <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. | 279 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. |
| 280 | You can use these kernels and images to get a system running and quickly get started | 280 | You can use these kernels and images to get a system running and quickly get started |
| 281 | on development tasks. | 281 | on development tasks. |
| 282 | </para> | 282 | </para> |
| @@ -355,12 +355,12 @@ | |||
| 355 | If the BSP supports multiple machines, multiple machine configuration files | 355 | If the BSP supports multiple machines, multiple machine configuration files |
| 356 | can be present. | 356 | can be present. |
| 357 | These filenames correspond to the values to which users have set the | 357 | These filenames correspond to the values to which users have set the |
| 358 | <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'><filename>MACHINE</filename></ulink> variable. | 358 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable. |
| 359 | </para> | 359 | </para> |
| 360 | 360 | ||
| 361 | <para> | 361 | <para> |
| 362 | These files define things such as the kernel package to use | 362 | These files define things such as the kernel package to use |
| 363 | (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink> | 363 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink> |
| 364 | of virtual/kernel), the hardware drivers to | 364 | of virtual/kernel), the hardware drivers to |
| 365 | include in different types of images, any special software components | 365 | include in different types of images, any special software components |
| 366 | that are needed, any bootloader information, and also any special image | 366 | that are needed, any bootloader information, and also any special image |
| @@ -392,7 +392,7 @@ | |||
| 392 | <para> | 392 | <para> |
| 393 | Tuning files are found in the <filename>meta/conf/machine/include</filename> | 393 | Tuning files are found in the <filename>meta/conf/machine/include</filename> |
| 394 | directory of the | 394 | directory of the |
| 395 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>. | 395 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>. |
| 396 | Tuning files can also reside in the BSP Layer itself. | 396 | Tuning files can also reside in the BSP Layer itself. |
| 397 | For example, the <filename>ia32-base.inc</filename> file resides in the | 397 | For example, the <filename>ia32-base.inc</filename> file resides in the |
| 398 | <filename>meta-intel</filename> BSP Layer in <filename>conf/machine/include</filename>. | 398 | <filename>meta-intel</filename> BSP Layer in <filename>conf/machine/include</filename>. |
| @@ -444,7 +444,7 @@ | |||
| 444 | formfactor recipe | 444 | formfactor recipe |
| 445 | <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, | 445 | <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, |
| 446 | which is found in the | 446 | which is found in the |
| 447 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>. | 447 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>. |
| 448 | </para></note> | 448 | </para></note> |
| 449 | </section> | 449 | </section> |
| 450 | 450 | ||
| @@ -510,7 +510,7 @@ | |||
| 510 | </para> | 510 | </para> |
| 511 | <para> | 511 | <para> |
| 512 | For your BSP, you typically want to use an existing Yocto Project kernel found in the | 512 | For your BSP, you typically want to use an existing Yocto Project kernel found in the |
| 513 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto | 513 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto |
| 514 | Project Files</ulink> at <filename>meta/recipes-kernel/linux</filename>. | 514 | Project Files</ulink> at <filename>meta/recipes-kernel/linux</filename>. |
| 515 | You can append your specific changes to the kernel recipe by using a | 515 | You can append your specific changes to the kernel recipe by using a |
| 516 | similarly named append file, which is located in BSP Layer (e.g. | 516 | similarly named append file, which is located in BSP Layer (e.g. |
| @@ -626,7 +626,7 @@ | |||
| 626 | The configuration options will likely end up in that location anyway if the BSP gets | 626 | The configuration options will likely end up in that location anyway if the BSP gets |
| 627 | added to the Yocto Project. | 627 | added to the Yocto Project. |
| 628 | For an example showing how to change the BSP configuration, see the | 628 | For an example showing how to change the BSP configuration, see the |
| 629 | "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#changing-the-bsp-configuration'>Changing the BSP Configuration</ulink>" section | 629 | "<ulink url='&YOCTO_DOCS_DEV_URL;#changing-the-bsp-configuration'>Changing the BSP Configuration</ulink>" section |
| 630 | in the Yocto Project Development Manual.</para> | 630 | in the Yocto Project Development Manual.</para> |
| 631 | <para> | 631 | <para> |
| 632 | In general, however, the Yocto Project maintainers take care of moving the | 632 | In general, however, the Yocto Project maintainers take care of moving the |
| @@ -670,7 +670,7 @@ | |||
| 670 | <para> | 670 | <para> |
| 671 | For cases where you can substitute something and still maintain functionality, | 671 | For cases where you can substitute something and still maintain functionality, |
| 672 | the Yocto Project website's | 672 | the Yocto Project website's |
| 673 | <ulink url='http://www.yoctoproject.org/download/all?keys=&download_type=1&download_version='>BSP Download Page</ulink> | 673 | <ulink url='&YOCTO_HOME_URL;/download/all?keys=&download_type=1&download_version='>BSP Download Page</ulink> |
| 674 | makes available 'de-featured' BSPs that are completely free of any IP encumbrances. | 674 | makes available 'de-featured' BSPs that are completely free of any IP encumbrances. |
| 675 | For these cases you can use the substitution directly and without any further licensing | 675 | For these cases you can use the substitution directly and without any further licensing |
| 676 | requirements. | 676 | requirements. |
| @@ -757,7 +757,7 @@ | |||
| 757 | <para> | 757 | <para> |
| 758 | Get a full-featured BSP recipe rather than a key. | 758 | Get a full-featured BSP recipe rather than a key. |
| 759 | You can do this by visiting the Yocto Project website's | 759 | You can do this by visiting the Yocto Project website's |
| 760 | <ulink url='http://www.yoctoproject.org/download'>Download</ulink> page and | 760 | <ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> page and |
| 761 | clicking on "BSP Downloads". | 761 | clicking on "BSP Downloads". |
| 762 | BSP tarballs that have proprietary information can be downloaded after agreeing | 762 | BSP tarballs that have proprietary information can be downloaded after agreeing |
| 763 | to licensing requirements as part of the download process. | 763 | to licensing requirements as part of the download process. |
