summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-02-14 09:51:29 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-03-02 12:57:20 +0000
commit63788f1f666f59ff9c4c56c9f28ac94a45ec9bf6 (patch)
treecd416d501a5f1819196798e872b6718630c618d5 /documentation/dev-manual/dev-manual-newbie.xml
parentb3b0317167dcda636c72409e18d6b13848b16066 (diff)
downloadpoky-63788f1f666f59ff9c4c56c9f28ac94a45ec9bf6.tar.gz
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 <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml34
1 files changed, 20 insertions, 14 deletions
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 @@
174 would the usual cross-development toolchain so that 174 would the usual cross-development toolchain so that
175 all developers can meet minimum version requirements 175 all developers can meet minimum version requirements
176 on most distributions.</para></listitem> 176 on most distributions.</para></listitem>
177 <listitem><para>Use a small number of high performance 177 <listitem><para>Use a small number of shared,
178 systems for testing purposes (e.g. dual six core Xeons 178 high performance systems for testing purposes
179 with 24GB RAM and plenty of disk space). 179 (e.g. dual six core Xeons with 24GB RAM and plenty of
180 disk space).
180 Developers can use these systems for wider, more 181 Developers can use these systems for wider, more
181 extensive testing while they continue to develop 182 extensive testing while they continue to develop
182 locally using their primary development system. 183 locally using their primary development system.
@@ -187,20 +188,26 @@
187 </section> 188 </section>
188 189
189 <section id='best-practices-source-control-management'> 190 <section id='best-practices-source-control-management'>
190 <title>Source Control Manangement (SCM)</title> 191 <title>Source Control Management (SCM)</title>
191 192
192 <para> 193 <para>
193 Keeping your 194 Keeping your
194 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> 195 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
195 and any software you are developing under the 196 and any software you are developing under the
196 control of an SCM system that is compatible 197 control of an SCM system that is compatible
197 with the OpenEmbedded build system is adviseable. 198 with the OpenEmbedded build system is advisable.
198 Of the two SCMs available (Git or Subversion), the 199 Of the SCMs BitBake supports, the
199 Yocto Project team strongly recommends using 200 Yocto Project team strongly recommends using
200 <link linkend='git'>Git</link>. 201 <link linkend='git'>Git</link>.
201 Git is a distributed system that is easy to backup 202 Git is a distributed system that is easy to backup
202 (each checkout is a backup in itself), allows you to work 203 (each checkout is a backup in itself), allows you to work
203 remotely, and then connect back to the infrastructue. 204 remotely, and then connect back to the infrastructure.
205 <note>
206 For information about BitBake and SCMs, see the
207 BitBake manual located in the
208 <filename>bitbake/doc/manual</filename> directory of the
209 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
210 </note>
204 </para> 211 </para>
205 212
206 <para> 213 <para>
@@ -211,7 +218,7 @@
211 <filename>gitolite</filename> with <filename>cgit</filename> 218 <filename>gitolite</filename> with <filename>cgit</filename>
212 being used to generate the web interface that lets you view the 219 being used to generate the web interface that lets you view the
213 repositories. 220 repositories.
214 The <filename>gitlite</filename> software identifies users 221 The <filename>gitolite</filename> software identifies users
215 using <filename>ssh</filename> keys and allows branch-based 222 using <filename>ssh</filename> keys and allows branch-based
216 access controls to repositories that you can control as little 223 access controls to repositories that you can control as little
217 or as much as necessary. 224 or as much as necessary.
@@ -278,7 +285,7 @@
278 <listitem><para>Shared output that allows developer 285 <listitem><para>Shared output that allows developer
279 testing and historical regression investigation 286 testing and historical regression investigation
280 </para></listitem> 287 </para></listitem>
281 <listitem><para>Creates output that can be use for releases 288 <listitem><para>Creates output that can be used for releases
282 </para></listitem> 289 </para></listitem>
283 <listitem><para>Allows scheduling of builds so that resources 290 <listitem><para>Allows scheduling of builds so that resources
284 can be used efficiently.</para></listitem> 291 can be used efficiently.</para></listitem>
@@ -309,7 +316,7 @@
309 <para> 316 <para>
310 As with any development environment, it is important 317 As with any development environment, it is important
311 to document the policy used as well as any main project 318 to document the policy used as well as any main project
312 guidelines so they are understoon by everyone. 319 guidelines so they are understood by everyone.
313 It is also a good idea to have well structured 320 It is also a good idea to have well structured
314 commit messages, which are usually a part of a project's 321 commit messages, which are usually a part of a project's
315 guidelines. 322 guidelines.
@@ -322,8 +329,7 @@
322 project, it is worth sharing those with the community as soon 329 project, it is worth sharing those with the community as soon
323 as possible. 330 as possible.
324 Chances are if you have discovered the need for changes, someone 331 Chances are if you have discovered the need for changes, someone
325 someone else in the community needs them also. 332 else in the community needs them also.
326 sooner than later.
327 </para> 333 </para>
328 </section> 334 </section>
329 335
@@ -331,7 +337,7 @@
331 <title>Summary</title> 337 <title>Summary</title>
332 338
333 <para> 339 <para>
334 This section summarizes thee key recommendations described in the 340 This section summarizes the key recommendations described in the
335 previous sections: 341 previous sections:
336 <itemizedlist> 342 <itemizedlist>
337 <listitem><para>Use <link linkend='git'>Git</link> 343 <listitem><para>Use <link linkend='git'>Git</link>
@@ -617,7 +623,7 @@
617 A package is generally the compiled binaries produced from the recipe's sources. 623 A package is generally the compiled binaries produced from the recipe's sources.
618 You ‘bake’ something by running it through BitBake.</para> 624 You ‘bake’ something by running it through BitBake.</para>
619 <para>It is worth noting that the term "package" can, in general, have subtle 625 <para>It is worth noting that the term "package" can, in general, have subtle
620 meanings. For example, the packages refered to in the 626 meanings. For example, the packages referred to in the
621 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are 627 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are
622 compiled binaries that when installed add functionality to your Linux 628 compiled binaries that when installed add functionality to your Linux
623 distribution.</para> 629 distribution.</para>