From e3e0d40704473e752d93de79cfb04a979c3073bb Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Mon, 11 Nov 2013 10:42:55 -0800 Subject: [PATCH] dev-manual: Small number of tweaks to ch 3, development manual. (From yocto-docs rev: f496e2fb8050830a2daf9f712a9b9b40b4025f1f) Signed-off-by: Scott Rifenbark Conflicts: documentation/dev-manual/dev-manual-newbie.xml Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-newbie.xml | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 2625a44f2c..694bb7c021 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -429,15 +429,17 @@ For any supported release of Yocto Project, you can go to the Yocto Project Website and - select the "Downloads" tab and get a tarball of the release. - You can also go to this site to download any supported BSP tarballs. - Unpacking the tarball gives you a hierarchical Source Directory that lets you develop - using the Yocto Project. - - - - Once you are set up through either tarball extraction or a checkout of Git repositories, - you are ready to develop. + select the "Downloads" tab and get a released tarball of the + poky repository or any supported BSP tarballs. + Unpacking these tarballs gives you a snapshot of the released + files. + + The recommended method for setting up the Yocto Project + Source Directory and the + files for supported BSPs (eg., meta-intel) is to + use Git to create a local copy of the + upstream repositories. + @@ -820,7 +822,8 @@ Git - The Yocto Project uses Git, which is a free, open source distributed version control system. + The Yocto Project makes extensive use of Git, + which is a free, open source distributed version control system. Git supports distributed development, non-linear development, and can handle large projects. It is best that you have some fundamental understanding of how Git tracks projects and how to work with Git if you are going to use the Yocto Project for development. @@ -924,7 +927,7 @@ local working branch based on a branch name, your local environment matches the "tip" of that development branch at the time you created your local branch, which could be - different than the files at the time of a similarly named release. + different from the files at the time of a similarly named release. In other words, creating and checking out a local branch based on the &DISTRO_NAME; branch name is not the same as cloning and checking out the master branch. @@ -1017,7 +1020,7 @@ will allow the change, and for ultimately pushing the change from your local Git repository into the project’s upstream (or master) repository. git status: Reports any modified files that - possibly need staged and committed. + possibly need to be staged and committed. git checkout <branch-name>: Changes your working branch. This command is analogous to "cd". @@ -1294,10 +1297,9 @@ Board Support Package (BSP) README Files: For BSP maintainers of supported BSPs, you can examine individual BSP README files. - Alternatively, you can examine the - MAINTAINERS file, which is found in the - meta-intel, for a list of all supported - BSP maintainers. + In addition, some layers (such as the meta-intel layer), + include a MAINTAINERS file which contains + a list of all supported BSP maintainers for that layer. Search by File: Using Git, you can enter the