diff options
| author |   Scott Rifenbark <srifenbark@gmail.com> | 2017-06-28 16:17:28 -0700 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-12 00:28:14 +0100 |
| commit | 1b2d89737f51b85b475688f978678feafc13e341 (patch) | |
| tree | 8e1279c686b0a2315143ae92f0d88c966249f7b7 | |
| parent | 95547dab77360d16af4b04d74c09daa2febc6577 (diff) | |
| download | openembedded-core-contrib-1b2d89737f51b85b475688f978678feafc13e341.tar.gz | |
dev-manual: Added branch clarification to checking out poky
Re-wordings to be clear about what the user is getting when
they check out a development branch of an upstream repository.
(From yocto-docs rev: deb6ecfd35a76760bc2270bbbc69aa232b0c8cc7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 1f617dc6a2..364a7631f2 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -611,9 +611,17 @@ When you clone the upstream poky repository, you have access to all its development branches. Each development branch in a repository is unique as it forks - off the repositories "master" branch. - To see and use the files of any branch locally, you need to - know the branch name and then checkout the branch. + off the "master" branch. + To see and use the files of a particular development branch + locally, you need to know the branch name and then specifically + check out that development branch. + <note> + Checking out an active development branch by branch name + gives you a snapshot of that particular branch at the time + you check it out. + Further development on top of the branch that occurs after + check it out can occur. + </note> <orderedlist> <listitem><para> <emphasis>Switch to the Poky Directory:</emphasis> @@ -648,7 +656,7 @@ </para></listitem> <listitem><para> <emphasis>Checkout the Branch:</emphasis> - Checkout the branch in which you want to work. + Checkout the development branch in which you want to work. For example, to access the files for the Yocto Project 2.3 Release (Pyro), use the following command: <literallayout class='monospaced'> @@ -656,8 +664,8 @@ Branch pyro set up to track remote branch pyro from origin. Switched to a new branch 'pyro' </literallayout> - The previous command checks out the "pyro" branch and - reports that the branch is tracking the upstream + The previous command checks out the "pyro" development + branch and reports that the branch is tracking the upstream "origin/pyro" branch.</para> <para>The following command displays the branches |