Bug 3274 - [DOC] Documenting development best practices using the Yocto Project
Summary: [DOC] Documenting development best practices using the Yocto Project
Status: VERIFIED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: unspecified
Hardware: All Multiple
: High enhancement
Target Milestone: 1.4 M4
Assignee: Scott Rifenbark
QA Contact:
URL: http://git.yoctoproject.org/cgit.cgi/...
Whiteboard: 14 Feb 2013
Depends on:
Blocks:
 
Reported: 2012-10-11 00:07 UTC by Song Liu
Modified: 2013-03-22 08:30 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Song Liu 2012-10-11 00:07:14 UTC
When people start using Yocto Project, they may run into all kinds of questions or obstacles and would like to know the best practices to resolve those issues. Many times, there are people who have had those issues before and already figured out the solution or workaround.

We need to documenting these best practices and share them with the community.
Comment 1 Richard Purdie 2012-11-12 22:52:04 UTC
"How to use YP in a work group?"
Comment 2 Scott Rifenbark 2012-11-13 00:18:47 UTC
It would be good to talk to some people using YP and see what type of development environment and flow they have set up.
Comment 3 Richard Purdie 2012-11-14 15:00:59 UTC
To start with we can at least offer some advice like:
* Use git as the source control system
* Maintain the metadata in layers as makes sense to your situation
* Separate metadata from the code of the projects using separate git repositories
* Setup sstate caches where the make sense (e.g. group of developers in the same office) either NFS or http
* Setup source mirrors where it makes sense (e.g. group of developers in the same office, also share the sources directory on developer machines)
* Setup an autobuilder and have it populate sources/sstate directories

Making it clear that you don't have to do these things and the setup can be customised as needed but these are best practisies we've found. Links from the above items to approproiate documentation would be needed.
Comment 4 Scott Rifenbark 2012-11-15 23:51:06 UTC
I will start with a separate section in the YP Development Manual using Richard's rudimentary list with cross-references as applicable.  We can build on it from there.

Scott
Comment 5 Scott Rifenbark 2012-11-27 18:51:58 UTC
I have updated the dev-manual so that the basis for this information now exists.  Richar suggested a new section name.  However, an existing section already exists.  I have added the best practices information to that section.  You can see the modified section at http://www.yoctoproject.org/docs/1.4/dev-manual/dev-manual.html#usingpoky-changes-collaborate. 

Please review and comment.

Scott
Comment 6 Scott Rifenbark 2013-02-12 23:12:10 UTC
I have created a first draft of this section re-write based on Richard Purdie's input via an email.  The draft needs reviewed.  You can find it at http://www.yoctoproject.org/docs/1.4/dev-manual/dev-manual.html#usingpoky-changes-collaborate.

Scott
Comment 7 Richard Purdie 2013-02-12 23:29:14 UTC
Looks good, a few things I noticed:

"Use a small number of high performance systems for testing purposes" -> add in that this is a shared system, the word shared should be in there somewhere to make things clear.

"Of the two SCMs available (Git or Subversion)" - there are more than those available, technically you could use any bitbake supports (mercurial, cvs, subversion, perforce and others). I don't want to list them here. Perhaps just say "Of the SCMs bitbake supports, the project recommeds using git". Point at the bitbake manual for details?

"Creates output that can be use for releases " -> *used*

" sooner than later." looks unloved :)
Comment 8 Richard Purdie 2013-02-14 10:14:32 UTC
Reassign to Scott since I think my work on this is done.
Comment 9 Scott Rifenbark 2013-02-14 15:55:30 UTC
All review comments applied and a spell-check run on the chapter.  Final can be viewed at http://www.yoctoproject.org/docs/1.4/dev-manual/dev-manual.html#usingpoky-changes-collaborate.

Closing this bug.

Scott
Comment 10 Stoicescu Cornel 2013-03-22 08:30:44 UTC
The mentioned information is contained in http://www.yoctoproject.org/docs/1.4/dev-manual/dev-manual.html#usingpoky-changes-collaborate.