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>
This commit is contained in:
Scott Rifenbark
2017-06-28 16:24:29 -07:00
committed by Richard Purdie
parent 1b2d89737f
commit b9430113c6

View File

@@ -686,13 +686,19 @@
<title>Checking Out by Tag in Poky</title> <title>Checking Out by Tag in Poky</title>
<para> <para>
Similar to branches, the upstream repository has tags used Similar to branches, the upstream repository uses tags
to mark significant commits such as a completed release or to mark specific commits associated with significant points in
stage of a release. a development branch (i.e. a release point or stage of a
release).
You might want to set up a local branch based on one of those You might want to set up a local branch based on one of those
points in the repository. points in the repository.
The process is similar to checking out by branch name except you The process is similar to checking out by branch name except you
use tag names. use tag names.
<note>
Checking out a branch based on a tag names gives you a
stable set of files not affected by development on the
branch above the tag.
</note>
<orderedlist> <orderedlist>
<listitem><para> <listitem><para>
<emphasis>Switch to the Poky Directory:</emphasis> <emphasis>Switch to the Poky Directory:</emphasis>
@@ -743,8 +749,9 @@
branch named "my_yocto_2.2_M2", which is based on branch named "my_yocto_2.2_M2", which is based on
the commit in the upstream poky repository that has the commit in the upstream poky repository that has
the same tag. the same tag.
The files you have available locally when you are In this example, the files you have available locally
checked out to that branch are a snapshot of the as a result of the <filename>checkout</filename>
command are a snapshot of the
"morty" development branch at the point where "morty" development branch at the point where
milestone two was reached. milestone two was reached.
</para></listitem> </para></listitem>