diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-11-27 12:44:39 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-03 13:53:00 +0000 |
| commit | 7c88384bb2349359a4753b424cd18e7dfdd6a870 (patch) | |
| tree | 007e8895f9e8317f5d77680bf4420af16a72da6c /documentation/dev-manual | |
| parent | 518efae890f78f7f446b743c3860fb4f84fb6052 (diff) | |
| download | poky-7c88384bb2349359a4753b424cd18e7dfdd6a870.tar.gz | |
documentation: dev-manual - Updated collaboration section
Fixes [YOCTO #3274]
I have added a new area at the bottom of the current
"Using the Yocto Project in a Team Environment" section.
This section is the spot for addressing what Richard Purdie
coined as "How to use YP in a work group." For now, the
changes are based on the information that Richard placed in
the Bugzilla entry. Presumably we can build on this information.
(From yocto-docs rev: 92c5d1b6ac6b553fab19410170364dca40123c59)
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')
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 38 |
1 files changed, 36 insertions, 2 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 37f705b0ee..76d4180c47 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -75,8 +75,8 @@ | |||
| 75 | Experience shows that buildbot is a good fit for this role. | 75 | Experience shows that buildbot is a good fit for this role. |
| 76 | What works well is to configure buildbot to make two types of builds: | 76 | What works well is to configure buildbot to make two types of builds: |
| 77 | incremental and full (from scratch). | 77 | incremental and full (from scratch). |
| 78 | See <ulink url='http://autobuilder.yoctoproject.org:8010/'>Welcome to the buildbot for the | 78 | See "<ulink url='http://autobuilder.yoctoproject.org:8010/'>Welcome to the buildbot for the Yocto Project</ulink>" |
| 79 | Yocto Project</ulink> for an example implementation that uses buildbot. | 79 | for an example implementation that uses buildbot. |
| 80 | </para> | 80 | </para> |
| 81 | 81 | ||
| 82 | <para> | 82 | <para> |
| @@ -117,6 +117,40 @@ | |||
| 117 | force any particular policy on users, unlike a lot of build systems. | 117 | force any particular policy on users, unlike a lot of build systems. |
| 118 | The system allows the best policies to be chosen for the given circumstances. | 118 | The system allows the best policies to be chosen for the given circumstances. |
| 119 | </para> | 119 | </para> |
| 120 | |||
| 121 | <para> | ||
| 122 | In general, best practices exist that make your work with the Yocto | ||
| 123 | Project easier in a team environment. | ||
| 124 | This list presents some of these practices you might consider following. | ||
| 125 | Of course, you need to understand that you do not have to follow these | ||
| 126 | practices and your setup can be totally controlled and customized by | ||
| 127 | your team: | ||
| 128 | <itemizedlist> | ||
| 129 | <listitem><para>Use <link linkend='git'>Git</link> | ||
| 130 | as the source control system.</para></listitem> | ||
| 131 | <listitem><para>Maintain your metadata in layers that make sense | ||
| 132 | for your situation. | ||
| 133 | See the "<link linkend='understanding-and-creating-layers'>Understanding | ||
| 134 | and Creating Layeres</link>" section for more information on | ||
| 135 | layers.</para></listitem> | ||
| 136 | <listitem><para>Separate the project's metadata and code by using | ||
| 137 | separate Git repositories. | ||
| 138 | See the "<link linkend='yocto-project-repositories'>Yocto Project | ||
| 139 | Source Repositories</link>" section for information on these | ||
| 140 | repositories. | ||
| 141 | See the "<link linkend='getting-setup'>Getting Set Up</link>" section | ||
| 142 | for information on how to set up various Yocto Project related | ||
| 143 | Git repositories.</para></listitem> | ||
| 144 | <listitem><para>Set up the directory for the shared state cache | ||
| 145 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink>) | ||
| 146 | where they make sense. | ||
| 147 | For example, set up the sstate cache for developers using the | ||
| 148 | same office and share source directories on the developer's | ||
| 149 | machines.</para></listitem> | ||
| 150 | <listitem><para>Set up an autobuilder and have it populate the | ||
| 151 | sstate cache and source directories.</para></listitem> | ||
| 152 | </itemizedlist> | ||
| 153 | </para> | ||
| 120 | </section> | 154 | </section> |
| 121 | 155 | ||
| 122 | <section id='yocto-project-repositories'> | 156 | <section id='yocto-project-repositories'> |
