summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrpjday@crashcourse.ca <rpjday@crashcourse.ca>2020-03-28 14:45:45 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-04-06 13:40:24 (GMT)
commitb31daa130a2836bd13221286d7e37ae38d4c8326 (patch)
treebeba99a892c08ab2af6ddd07ea28df444ae773cd
parentfd54658d874ef57ebc8a5342f101362a2616dc11 (diff)
downloadpoky-b31daa130a2836bd13221286d7e37ae38d4c8326.tar.gz
dev-manual: minor tweaks, rewording, grammar for chapter 2
(From yocto-docs rev: 706386ac094479916e1cc482e56a6433caa85e1a) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-start.xml54
1 files changed, 28 insertions, 26 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 2dc318a..a151ba6 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -7,7 +7,7 @@
7<title>Setting Up to Use the Yocto Project</title> 7<title>Setting Up to Use the Yocto Project</title>
8 8
9<para> 9<para>
10 This chapter provides procedures related to getting set up to use the 10 This chapter provides guidance on how to prepare to use the
11 Yocto Project. 11 Yocto Project.
12 You can learn about creating a team environment that develops using the 12 You can learn about creating a team environment that develops using the
13 Yocto Project, how to set up a 13 Yocto Project, how to set up a
@@ -24,9 +24,9 @@
24 Project in a team development environment, or how to scale it for a 24 Project in a team development environment, or how to scale it for a
25 large team of developers. 25 large team of developers.
26 You can adapt the Yocto Project to many different use cases and 26 You can adapt the Yocto Project to many different use cases and
27 scenarios. 27 scenarios;
28 However, this flexibility could cause difficulties if you are trying 28 however, this flexibility could cause difficulties if you are trying
29 to create a working setup that scales across a large team. 29 to create a working setup that scales effectively.
30 </para> 30 </para>
31 31
32 <para> 32 <para>
@@ -35,17 +35,17 @@
35 that can help you get the results you want. 35 that can help you get the results you want.
36 The procedure is high-level and presents some of the project's most 36 The procedure is high-level and presents some of the project's most
37 successful experiences, practices, solutions, and available 37 successful experiences, practices, solutions, and available
38 technologies that have proved to work well in the past. 38 technologies that have proved to work well in the past;
39 Keep in mind, the procedure here is a starting point. 39 however, keep in mind, the procedure here is simply a starting point.
40 You can build off these steps and customize the procedure to fit any 40 You can build off these steps and customize the procedure to fit any
41 particular working environment and set of practices. 41 particular working environment and set of practices.
42 <orderedlist> 42 <orderedlist>
43 <listitem><para> 43 <listitem><para>
44 <emphasis>Determine Who is Going to be Developing:</emphasis> 44 <emphasis>Determine Who is Going to be Developing:</emphasis>
45 You need to understand who is going to be doing anything 45 You first need to understand who is going to be doing anything
46 related to the Yocto Project and determine their roles. 46 related to the Yocto Project and determine their roles.
47 Making this determination is essential to completing 47 Making this determination is essential to completing
48 steps two and three, which are to get your equipment together 48 subsequent steps, which are to get your equipment together
49 and set up your development environment's hardware topology. 49 and set up your development environment's hardware topology.
50 </para> 50 </para>
51 51
@@ -64,8 +64,8 @@
64 <listitem><para> 64 <listitem><para>
65 <emphasis>Build Engineer:</emphasis> 65 <emphasis>Build Engineer:</emphasis>
66 This type of developer manages Autobuilders and 66 This type of developer manages Autobuilders and
67 releases. 67 releases. Depending on the specifics of the environment,
68 Not all environments need a Build Engineer. 68 not all situations might need a Build Engineer.
69 </para></listitem> 69 </para></listitem>
70 <listitem><para> 70 <listitem><para>
71 <emphasis>Test Engineer:</emphasis> 71 <emphasis>Test Engineer:</emphasis>
@@ -88,6 +88,11 @@
88 You can help ensure efficiency by having any machines used 88 You can help ensure efficiency by having any machines used
89 for testing or that run Autobuilders be as high performance 89 for testing or that run Autobuilders be as high performance
90 as possible. 90 as possible.
91 <note>
92 Given sufficient processing power, you might also consider
93 building Yocto Project development containers to be run
94 under Docker, which is described later.
95 </note>
91 </para></listitem> 96 </para></listitem>
92 <listitem><para> 97 <listitem><para>
93 <emphasis>Understand the Hardware Topology of the Environment:</emphasis> 98 <emphasis>Understand the Hardware Topology of the Environment:</emphasis>
@@ -114,10 +119,10 @@
114 and any software you are developing under the control of an SCM 119 and any software you are developing under the control of an SCM
115 system that is compatible with the OpenEmbedded build system 120 system that is compatible with the OpenEmbedded build system
116 is advisable. 121 is advisable.
117 Of the SCMs BitBake supports, the Yocto Project team strongly 122 Of all of the SCMs supported by BitBake, the Yocto Project team strongly
118 recommends using 123 recommends using
119 <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>. 124 <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>.
120 Git is a distributed system that is easy to backup, 125 Git is a distributed system that is easy to back up,
121 allows you to work remotely, and then connects back to the 126 allows you to work remotely, and then connects back to the
122 infrastructure. 127 infrastructure.
123 <note> 128 <note>
@@ -302,7 +307,7 @@
302 <para>As with any development environment, it is important 307 <para>As with any development environment, it is important
303 to document the policy used as well as any main project 308 to document the policy used as well as any main project
304 guidelines so they are understood by everyone. 309 guidelines so they are understood by everyone.
305 It is also a good idea to have well structured 310 It is also a good idea to have well-structured
306 commit messages, which are usually a part of a project's 311 commit messages, which are usually a part of a project's
307 guidelines. 312 guidelines.
308 Good commit messages are essential when looking back in time and 313 Good commit messages are essential when looking back in time and
@@ -444,7 +449,7 @@
444 You should have a reasonably current Linux-based host 449 You should have a reasonably current Linux-based host
445 system. 450 system.
446 You will have the best results with a recent release of 451 You will have the best results with a recent release of
447 Fedora, openSUSE, Debian, Ubuntu, or CentOS as these 452 Fedora, openSUSE, Debian, Ubuntu, RHEL or CentOS as these
448 releases are frequently tested against the Yocto Project 453 releases are frequently tested against the Yocto Project
449 and officially supported. 454 and officially supported.
450 For a list of the distributions under validation and their 455 For a list of the distributions under validation and their
@@ -795,9 +800,8 @@
795 <title>Locating Yocto Project Source Files</title> 800 <title>Locating Yocto Project Source Files</title>
796 801
797 <para> 802 <para>
798 This section shows you how to locate and access the 803 This section shows you how to locate, fetch and configure the source
799 source files that ship with the Yocto Project. 804 files you'll need to work with the Yocto Project.
800 You establish and use these local files to work on projects.
801 <note><title>Notes</title> 805 <note><title>Notes</title>
802 <itemizedlist> 806 <itemizedlist>
803 <listitem><para> 807 <listitem><para>
@@ -1154,20 +1158,18 @@
1154 . 1158 .
1155 . 1159 .
1156 . 1160 .
1157 remotes/origin/pyro
1158 remotes/origin/pyro-next
1159 remotes/origin/rocko
1160 remotes/origin/rocko-next
1161 remotes/origin/sumo
1162 remotes/origin/sumo-next
1163 remotes/origin/thud 1161 remotes/origin/thud
1164 remotes/origin/thud-next 1162 remotes/origin/thud-next
1165 remotes/origin/warrior 1163 remotes/origin/warrior
1164 remotes/origin/warrior-next
1165 remotes/origin/zeus
1166 remotes/origin/zeus-next
1167 ... and so on ...
1166 </literallayout> 1168 </literallayout>
1167 </para></listitem> 1169 </para></listitem>
1168 <listitem><para> 1170 <listitem><para>
1169 <emphasis>Checkout the Branch:</emphasis> 1171 <emphasis>Check out the Branch:</emphasis>
1170 Checkout the development branch in which you want to work. 1172 Check out the development branch in which you want to work.
1171 For example, to access the files for the Yocto Project 1173 For example, to access the files for the Yocto Project
1172 &DISTRO; Release (&DISTRO_NAME;), use the following command: 1174 &DISTRO; Release (&DISTRO_NAME;), use the following command:
1173 <literallayout class='monospaced'> 1175 <literallayout class='monospaced'>
@@ -1253,7 +1255,7 @@
1253 </literallayout> 1255 </literallayout>
1254 </para></listitem> 1256 </para></listitem>
1255 <listitem><para> 1257 <listitem><para>
1256 <emphasis>Checkout the Branch:</emphasis> 1258 <emphasis>Check out the Branch:</emphasis>
1257 <literallayout class='monospaced'> 1259 <literallayout class='monospaced'>
1258 $ git checkout tags/&DISTRO_REL_TAG; -b my_yocto_&DISTRO; 1260 $ git checkout tags/&DISTRO_REL_TAG; -b my_yocto_&DISTRO;
1259 Switched to a new branch 'my_yocto_&DISTRO;' 1261 Switched to a new branch 'my_yocto_&DISTRO;'