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 /documentation | |
parent | 95547dab77360d16af4b04d74c09daa2febc6577 (diff) | |
download | poky-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>
Diffstat (limited to 'documentation')
-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 @@ | |||
611 | When you clone the upstream poky repository, you have access to | 611 | When you clone the upstream poky repository, you have access to |
612 | all its development branches. | 612 | all its development branches. |
613 | Each development branch in a repository is unique as it forks | 613 | Each development branch in a repository is unique as it forks |
614 | off the repositories "master" branch. | 614 | off the "master" branch. |
615 | To see and use the files of any branch locally, you need to | 615 | To see and use the files of a particular development branch |
616 | know the branch name and then checkout the branch. | 616 | locally, you need to know the branch name and then specifically |
617 | check out that development branch. | ||
618 | <note> | ||
619 | Checking out an active development branch by branch name | ||
620 | gives you a snapshot of that particular branch at the time | ||
621 | you check it out. | ||
622 | Further development on top of the branch that occurs after | ||
623 | check it out can occur. | ||
624 | </note> | ||
617 | <orderedlist> | 625 | <orderedlist> |
618 | <listitem><para> | 626 | <listitem><para> |
619 | <emphasis>Switch to the Poky Directory:</emphasis> | 627 | <emphasis>Switch to the Poky Directory:</emphasis> |
@@ -648,7 +656,7 @@ | |||
648 | </para></listitem> | 656 | </para></listitem> |
649 | <listitem><para> | 657 | <listitem><para> |
650 | <emphasis>Checkout the Branch:</emphasis> | 658 | <emphasis>Checkout the Branch:</emphasis> |
651 | Checkout the branch in which you want to work. | 659 | Checkout the development branch in which you want to work. |
652 | For example, to access the files for the Yocto Project | 660 | For example, to access the files for the Yocto Project |
653 | 2.3 Release (Pyro), use the following command: | 661 | 2.3 Release (Pyro), use the following command: |
654 | <literallayout class='monospaced'> | 662 | <literallayout class='monospaced'> |
@@ -656,8 +664,8 @@ | |||
656 | Branch pyro set up to track remote branch pyro from origin. | 664 | Branch pyro set up to track remote branch pyro from origin. |
657 | Switched to a new branch 'pyro' | 665 | Switched to a new branch 'pyro' |
658 | </literallayout> | 666 | </literallayout> |
659 | The previous command checks out the "pyro" branch and | 667 | The previous command checks out the "pyro" development |
660 | reports that the branch is tracking the upstream | 668 | branch and reports that the branch is tracking the upstream |
661 | "origin/pyro" branch.</para> | 669 | "origin/pyro" branch.</para> |
662 | 670 | ||
663 | <para>The following command displays the branches | 671 | <para>The following command displays the branches |