From f937e05b44f6b46ba60c4d3a18f57bb78b0ec7c0 Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Fri, 1 Aug 2014 09:01:45 +0300 Subject: dev-manual: Miscellaneous fixes in the newbie chapter. (From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-newbie.xml | 42 +++++++++++++------------- 1 file changed, 21 insertions(+), 21 deletions(-) (limited to 'documentation') 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 @@ - A benchmark example of an open source project is the Linux Kernel, which was initially conceived + A benchmark example of an open source project is the Linux kernel, which was initially conceived and created by Finnish computer science student Linus Torvalds in 1991. Conversely, a good example of a non-open source project is the Windows family of operating @@ -443,7 +443,7 @@ Be sure to always work in matching branches for both - the meta-intel repository and the + the selected BSP repository and the Source Directory (i.e. poky) repository. For example, if you have checked out the "master" branch @@ -508,7 +508,8 @@ The filenames can differ only in the file type suffix used (e.g. formfactor_0.0.bb and formfactor_0.0.bbappend). - Information in append files overrides the information in the similarly-named recipe file. + Information in append files extends or overrides the + information in the similarly-named recipe file. For an example of an append file in use, see the "Using .bbappend Files" section. @@ -669,7 +670,7 @@ chapter in the Yocto Project Reference Manual. Layer: A collection of recipes representing the core, a BSP, or an application stack. - For a discussion on BSP Layers, see the + For a discussion specifically on BSP Layers, see the "BSP Layers" section in the Yocto Project Board Support Packages (BSP) Developer's Guide. @@ -699,7 +700,7 @@ It is worth noting that the term "package" can, in general, have subtle meanings. For example, the packages referred to in the "The Packages" section are - compiled binaries that when installed add functionality to your Linux + compiled binaries that, when installed, add functionality to your Linux distribution. Another point worth noting is that historically within the Yocto Project, recipes were referred to as packages - thus, the existence of several BitBake @@ -733,12 +734,11 @@ the Yocto Project. Recipe: A set of instructions for building packages. - A recipe describes where you get source code and which patches - to apply. - Recipes describe dependencies for libraries or for other - recipes, and they also contain configuration and compilation - options. - Recipes contain the logical unit of execution, the software + A recipe describes where you get source code, which patches + to apply, how to configure the source, how to compile it and so on. + Recipes also describe dependencies for libraries or for other + recipes. + Recipes represent the logical unit of execution, the software to build, the images to build, and use the .bb file extension. @@ -778,7 +778,7 @@ folder is also named "poky". While it is not recommended that you use tarball expansion - to setup the Source Directory, if you do, the top-level + to set up the Source Directory, if you do, the top-level directory name of the Source Directory is derived from the Yocto Project release tarball. For example, downloading and unpacking @@ -844,7 +844,7 @@ license is distributed with that software. MIT is also compatible with the GNU General Public License (GPL). Patches to the Yocto Project follow the upstream licensing scheme. - You can find information on the MIT license at + You can find information on the MIT license here. You can find information on the GNU GPL here. @@ -976,7 +976,7 @@ Each of these branches represents a specific area of development. The master branch represents the current or most recent development. - All other branches represent off-shoots of the master + All other branches represent offshoots of the master branch. @@ -1029,7 +1029,7 @@ Some key tags are dylan-9.0.0, - dora-10.0.0, + dora-10.0.0, daisy-11.0.0, and &DISTRO_NAME;-&POKYVERSION;. These tags represent Yocto Project releases. @@ -1175,10 +1175,10 @@ For the Yocto Project, a key individual called the "maintainer" is responsible for the "master" branch of a given Git repository. The "master" branch is the “upstream” repository where the final builds of the project occur. - The maintainer is responsible for allowing changes in from other developers and for + The maintainer is responsible for accepting changes from other developers and for organizing the underlying branch structure to reflect release strategies and so forth. - For information on finding out who is responsible (maintains) - for a particular area of code, see the + For information on finding out who is responsible for (maintains) + a particular area of code, see the "How to Submit a Change" section. @@ -1332,9 +1332,9 @@ a bug. When submitting a new bug, be sure to choose the appropriate Classification, Product, and Component for which the issue was found. - Defects for the Yocto Project fall into one of six classifications: Yocto Project - Components, Infrastructure, Build System & Metadata, Documentation, - QA/Testing, and Runtime. + Defects for the Yocto Project fall into one of seven classifications: + Yocto Project Components, Infrastructure, Build System & Metadata, + Documentation, QA/Testing, Runtime and Hardware. Each of these Classifications break down into multiple Products and, in some cases, multiple Components. Use the bug form to choose the correct Hardware and Architecture -- cgit 1.2.3-korg