diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-28 16:24:29 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-12 00:28:14 +0100 |
commit | b9430113c6455c858df5e3b5ee08837bc833243f (patch) | |
tree | a413c0d84d734dedb6964dcf4ffbc4740da12527 /documentation | |
parent | 1b2d89737f51b85b475688f978678feafc13e341 (diff) | |
download | poky-b9430113c6455c858df5e3b5ee08837bc833243f.tar.gz |
dev-manual: Clarifications for files in checkout out by tag
I put in some edits to be very clear on the state of the files
for the user when they check out by tag.
(From yocto-docs rev: 622d324e7f167f55a5de86ec7af65d7554f2aec8)
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 | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 364a7631f2..0e48043d38 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -686,13 +686,19 @@ | |||
686 | <title>Checking Out by Tag in Poky</title> | 686 | <title>Checking Out by Tag in Poky</title> |
687 | 687 | ||
688 | <para> | 688 | <para> |
689 | Similar to branches, the upstream repository has tags used | 689 | Similar to branches, the upstream repository uses tags |
690 | to mark significant commits such as a completed release or | 690 | to mark specific commits associated with significant points in |
691 | stage of a release. | 691 | a development branch (i.e. a release point or stage of a |
692 | release). | ||
692 | You might want to set up a local branch based on one of those | 693 | You might want to set up a local branch based on one of those |
693 | points in the repository. | 694 | points in the repository. |
694 | The process is similar to checking out by branch name except you | 695 | The process is similar to checking out by branch name except you |
695 | use tag names. | 696 | use tag names. |
697 | <note> | ||
698 | Checking out a branch based on a tag names gives you a | ||
699 | stable set of files not affected by development on the | ||
700 | branch above the tag. | ||
701 | </note> | ||
696 | <orderedlist> | 702 | <orderedlist> |
697 | <listitem><para> | 703 | <listitem><para> |
698 | <emphasis>Switch to the Poky Directory:</emphasis> | 704 | <emphasis>Switch to the Poky Directory:</emphasis> |
@@ -743,8 +749,9 @@ | |||
743 | branch named "my_yocto_2.2_M2", which is based on | 749 | branch named "my_yocto_2.2_M2", which is based on |
744 | the commit in the upstream poky repository that has | 750 | the commit in the upstream poky repository that has |
745 | the same tag. | 751 | the same tag. |
746 | The files you have available locally when you are | 752 | In this example, the files you have available locally |
747 | checked out to that branch are a snapshot of the | 753 | as a result of the <filename>checkout</filename> |
754 | command are a snapshot of the | ||
748 | "morty" development branch at the point where | 755 | "morty" development branch at the point where |
749 | milestone two was reached. | 756 | milestone two was reached. |
750 | </para></listitem> | 757 | </para></listitem> |