diff options
author | Robert P. J. Day <rpjday@crashcourse.ca> | 2014-08-01 09:01:45 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-08-02 10:00:26 +0100 |
commit | f937e05b44f6b46ba60c4d3a18f57bb78b0ec7c0 (patch) | |
tree | 36c191bb4386e99ea36f89372c79f22fc4cb5f64 | |
parent | 3152e693837e72d08a2eda58bb81eefcd4150250 (diff) | |
download | poky-f937e05b44f6b46ba60c4d3a18f57bb78b0ec7c0.tar.gz |
dev-manual: Miscellaneous fixes in the newbie chapter.
(From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309)
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-newbie.xml | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0f7708e718..f5f23f4d7c 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -41,7 +41,7 @@ | |||
41 | </para> | 41 | </para> |
42 | 42 | ||
43 | <para> | 43 | <para> |
44 | A benchmark example of an open source project is the Linux Kernel, which was initially conceived | 44 | A benchmark example of an open source project is the Linux kernel, which was initially conceived |
45 | and created by Finnish computer science student Linus Torvalds in 1991. | 45 | and created by Finnish computer science student Linus Torvalds in 1991. |
46 | Conversely, a good example of a non-open source project is the | 46 | Conversely, a good example of a non-open source project is the |
47 | <trademark class='registered'>Windows</trademark> family of operating | 47 | <trademark class='registered'>Windows</trademark> family of operating |
@@ -443,7 +443,7 @@ | |||
443 | </para></listitem> | 443 | </para></listitem> |
444 | <listitem><para> | 444 | <listitem><para> |
445 | Be sure to always work in matching branches for both | 445 | Be sure to always work in matching branches for both |
446 | the <filename>meta-intel</filename> repository and the | 446 | the selected BSP repository and the |
447 | <link linkend='source-directory'>Source Directory</link> | 447 | <link linkend='source-directory'>Source Directory</link> |
448 | (i.e. <filename>poky</filename>) repository. | 448 | (i.e. <filename>poky</filename>) repository. |
449 | For example, if you have checked out the "master" branch | 449 | For example, if you have checked out the "master" branch |
@@ -508,7 +508,8 @@ | |||
508 | The filenames can differ only in the file type suffix used (e.g. | 508 | The filenames can differ only in the file type suffix used (e.g. |
509 | <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>). | 509 | <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>). |
510 | </para> | 510 | </para> |
511 | <para>Information in append files overrides the information in the similarly-named recipe file. | 511 | <para>Information in append files extends or overrides the |
512 | information in the similarly-named recipe file. | ||
512 | For an example of an append file in use, see the | 513 | For an example of an append file in use, see the |
513 | "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" section. | 514 | "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" section. |
514 | <note> | 515 | <note> |
@@ -669,7 +670,7 @@ | |||
669 | chapter in the Yocto Project Reference Manual.</para></listitem> | 670 | chapter in the Yocto Project Reference Manual.</para></listitem> |
670 | <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, | 671 | <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, |
671 | a BSP, or an application stack. | 672 | a BSP, or an application stack. |
672 | For a discussion on BSP Layers, see the | 673 | For a discussion specifically on BSP Layers, see the |
673 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" | 674 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
674 | section in the Yocto Project Board Support Packages (BSP) | 675 | section in the Yocto Project Board Support Packages (BSP) |
675 | Developer's Guide.</para></listitem> | 676 | Developer's Guide.</para></listitem> |
@@ -699,7 +700,7 @@ | |||
699 | <para>It is worth noting that the term "package" can, in general, have subtle | 700 | <para>It is worth noting that the term "package" can, in general, have subtle |
700 | meanings. For example, the packages referred to in the | 701 | meanings. For example, the packages referred to in the |
701 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are | 702 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are |
702 | compiled binaries that when installed add functionality to your Linux | 703 | compiled binaries that, when installed, add functionality to your Linux |
703 | distribution.</para> | 704 | distribution.</para> |
704 | <para>Another point worth noting is that historically within the Yocto Project, | 705 | <para>Another point worth noting is that historically within the Yocto Project, |
705 | recipes were referred to as packages - thus, the existence of several BitBake | 706 | recipes were referred to as packages - thus, the existence of several BitBake |
@@ -733,12 +734,11 @@ | |||
733 | the Yocto Project.</para></listitem> | 734 | the Yocto Project.</para></listitem> |
734 | <listitem><para><emphasis>Recipe:</emphasis> | 735 | <listitem><para><emphasis>Recipe:</emphasis> |
735 | A set of instructions for building packages. | 736 | A set of instructions for building packages. |
736 | A recipe describes where you get source code and which patches | 737 | A recipe describes where you get source code, which patches |
737 | to apply. | 738 | to apply, how to configure the source, how to compile it and so on. |
738 | Recipes describe dependencies for libraries or for other | 739 | Recipes also describe dependencies for libraries or for other |
739 | recipes, and they also contain configuration and compilation | 740 | recipes. |
740 | options. | 741 | Recipes represent the logical unit of execution, the software |
741 | Recipes contain the logical unit of execution, the software | ||
742 | to build, the images to build, and use the | 742 | to build, the images to build, and use the |
743 | <filename>.bb</filename> file extension. | 743 | <filename>.bb</filename> file extension. |
744 | </para></listitem> | 744 | </para></listitem> |
@@ -778,7 +778,7 @@ | |||
778 | folder is also named "poky".</para> | 778 | folder is also named "poky".</para> |
779 | 779 | ||
780 | <para>While it is not recommended that you use tarball expansion | 780 | <para>While it is not recommended that you use tarball expansion |
781 | to setup the Source Directory, if you do, the top-level | 781 | to set up the Source Directory, if you do, the top-level |
782 | directory name of the Source Directory is derived from the | 782 | directory name of the Source Directory is derived from the |
783 | Yocto Project release tarball. | 783 | Yocto Project release tarball. |
784 | For example, downloading and unpacking | 784 | For example, downloading and unpacking |
@@ -844,7 +844,7 @@ | |||
844 | license is distributed with that software. | 844 | license is distributed with that software. |
845 | MIT is also compatible with the GNU General Public License (GPL). | 845 | MIT is also compatible with the GNU General Public License (GPL). |
846 | Patches to the Yocto Project follow the upstream licensing scheme. | 846 | Patches to the Yocto Project follow the upstream licensing scheme. |
847 | You can find information on the MIT license at | 847 | You can find information on the MIT license |
848 | <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>. | 848 | <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>. |
849 | You can find information on the GNU GPL <ulink url='http://www.opensource.org/licenses/LGPL-3.0'> | 849 | You can find information on the GNU GPL <ulink url='http://www.opensource.org/licenses/LGPL-3.0'> |
850 | here</ulink>. | 850 | here</ulink>. |
@@ -976,7 +976,7 @@ | |||
976 | Each of these branches represents a specific area of development. | 976 | Each of these branches represents a specific area of development. |
977 | The <filename>master</filename> branch represents the current or most recent | 977 | The <filename>master</filename> branch represents the current or most recent |
978 | development. | 978 | development. |
979 | All other branches represent off-shoots of the <filename>master</filename> | 979 | All other branches represent offshoots of the <filename>master</filename> |
980 | branch. | 980 | branch. |
981 | </para> | 981 | </para> |
982 | 982 | ||
@@ -1029,7 +1029,7 @@ | |||
1029 | 1029 | ||
1030 | <para> | 1030 | <para> |
1031 | Some key tags are <filename>dylan-9.0.0</filename>, | 1031 | Some key tags are <filename>dylan-9.0.0</filename>, |
1032 | <filename>dora-10.0.0</filename>, | 1032 | <filename>dora-10.0.0</filename>, <filename>daisy-11.0.0</filename>, |
1033 | and <filename>&DISTRO_NAME;-&POKYVERSION;</filename>. | 1033 | and <filename>&DISTRO_NAME;-&POKYVERSION;</filename>. |
1034 | These tags represent Yocto Project releases. | 1034 | These tags represent Yocto Project releases. |
1035 | </para> | 1035 | </para> |
@@ -1175,10 +1175,10 @@ | |||
1175 | For the Yocto Project, a key individual called the "maintainer" is responsible for the "master" | 1175 | For the Yocto Project, a key individual called the "maintainer" is responsible for the "master" |
1176 | branch of a given Git repository. | 1176 | branch of a given Git repository. |
1177 | The "master" branch is the “upstream” repository where the final builds of the project occur. | 1177 | The "master" branch is the “upstream” repository where the final builds of the project occur. |
1178 | The maintainer is responsible for allowing changes in from other developers and for | 1178 | The maintainer is responsible for accepting changes from other developers and for |
1179 | organizing the underlying branch structure to reflect release strategies and so forth. | 1179 | organizing the underlying branch structure to reflect release strategies and so forth. |
1180 | <note>For information on finding out who is responsible (maintains) | 1180 | <note>For information on finding out who is responsible for (maintains) |
1181 | for a particular area of code, see the | 1181 | a particular area of code, see the |
1182 | "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" | 1182 | "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" |
1183 | section. | 1183 | section. |
1184 | </note> | 1184 | </note> |
@@ -1332,9 +1332,9 @@ | |||
1332 | a bug.</para></listitem> | 1332 | a bug.</para></listitem> |
1333 | <listitem><para>When submitting a new bug, be sure to choose the appropriate | 1333 | <listitem><para>When submitting a new bug, be sure to choose the appropriate |
1334 | Classification, Product, and Component for which the issue was found. | 1334 | Classification, Product, and Component for which the issue was found. |
1335 | Defects for the Yocto Project fall into one of six classifications: Yocto Project | 1335 | Defects for the Yocto Project fall into one of seven classifications: |
1336 | Components, Infrastructure, Build System & Metadata, Documentation, | 1336 | Yocto Project Components, Infrastructure, Build System & Metadata, |
1337 | QA/Testing, and Runtime. | 1337 | Documentation, QA/Testing, Runtime and Hardware. |
1338 | Each of these Classifications break down into multiple Products and, in some | 1338 | Each of these Classifications break down into multiple Products and, in some |
1339 | cases, multiple Components.</para></listitem> | 1339 | cases, multiple Components.</para></listitem> |
1340 | <listitem><para>Use the bug form to choose the correct Hardware and Architecture | 1340 | <listitem><para>Use the bug form to choose the correct Hardware and Architecture |