From 63788f1f666f59ff9c4c56c9f28ac94a45ec9bf6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 14 Feb 2013 09:51:29 -0600 Subject: dev-manual: Edits to the "Working in a Team Environment" section. Fixes YOCTO #3274 Applied various review edits from Richard Purdie. Additionally, I ran a spell-check on the chapter and caught some typos. I fixed these as necessary. (From yocto-docs rev: 794a13d26bb7a9e268b16f809158a6af58cc3ce8) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-newbie.xml | 34 +++++++++++++++----------- 1 file changed, 20 insertions(+), 14 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 869790d99f..abf0890d65 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -174,9 +174,10 @@ would the usual cross-development toolchain so that all developers can meet minimum version requirements on most distributions. - Use a small number of high performance - systems for testing purposes (e.g. dual six core Xeons - with 24GB RAM and plenty of disk space). + Use a small number of shared, + high performance systems for testing purposes + (e.g. dual six core Xeons with 24GB RAM and plenty of + disk space). Developers can use these systems for wider, more extensive testing while they continue to develop locally using their primary development system. @@ -187,20 +188,26 @@
- Source Control Manangement (SCM) + Source Control Management (SCM) Keeping your Metadata and any software you are developing under the control of an SCM system that is compatible - with the OpenEmbedded build system is adviseable. - Of the two SCMs available (Git or Subversion), the + with the OpenEmbedded build system is advisable. + Of the SCMs BitBake supports, the Yocto Project team strongly recommends using Git. Git is a distributed system that is easy to backup (each checkout is a backup in itself), allows you to work - remotely, and then connect back to the infrastructue. + remotely, and then connect back to the infrastructure. + + For information about BitBake and SCMs, see the + BitBake manual located in the + bitbake/doc/manual directory of the + Source Directory. + @@ -211,7 +218,7 @@ gitolite with cgit being used to generate the web interface that lets you view the repositories. - The gitlite software identifies users + The gitolite software identifies users using ssh keys and allows branch-based access controls to repositories that you can control as little or as much as necessary. @@ -278,7 +285,7 @@ Shared output that allows developer testing and historical regression investigation - Creates output that can be use for releases + Creates output that can be used for releases Allows scheduling of builds so that resources can be used efficiently. @@ -309,7 +316,7 @@ As with any development environment, it is important to document the policy used as well as any main project - guidelines so they are understoon by everyone. + guidelines so they are understood by everyone. It is also a good idea to have well structured commit messages, which are usually a part of a project's guidelines. @@ -322,8 +329,7 @@ project, it is worth sharing those with the community as soon as possible. Chances are if you have discovered the need for changes, someone - someone else in the community needs them also. - sooner than later. + else in the community needs them also.
@@ -331,7 +337,7 @@ Summary - This section summarizes thee key recommendations described in the + This section summarizes the key recommendations described in the previous sections: Use Git @@ -617,7 +623,7 @@ A package is generally the compiled binaries produced from the recipe's sources. You ‘bake’ something by running it through BitBake. It is worth noting that the term "package" can, in general, have subtle - meanings. For example, the packages refered to in the + meanings. For example, the packages referred to in the "The Packages" section are compiled binaries that when installed add functionality to your Linux distribution. -- cgit 1.2.3-korg