summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2013-11-11 10:42:55 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:55 +0000
commite3e0d40704473e752d93de79cfb04a979c3073bb (patch)
tree7ddda8719e95485e00e9fb2d02a925de18f8f28e /documentation/dev-manual
parent803300cc126ab5581454d0dfb153d5c11998f5bc (diff)
downloadpoky-e3e0d40704473e752d93de79cfb04a979c3073bb.tar.gz
dev-manual: Small number of tweaks to ch 3, development manual.
(From yocto-docs rev: f496e2fb8050830a2daf9f712a9b9b40b4025f1f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/dev-manual/dev-manual-newbie.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml34
1 files 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 @@
429 <para> 429 <para>
430 For any supported release of Yocto Project, you can go to the 430 For any supported release of Yocto Project, you can go to the
431 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and 431 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and
432 select the "Downloads" tab and get a tarball of the release. 432 select the "Downloads" tab and get a released tarball of the
433 You can also go to this site to download any supported BSP tarballs. 433 <filename>poky</filename> repository or any supported BSP tarballs.
434 Unpacking the tarball gives you a hierarchical Source Directory that lets you develop 434 Unpacking these tarballs gives you a snapshot of the released
435 using the Yocto Project. 435 files.
436 </para> 436 <note>
437 437 The recommended method for setting up the Yocto Project
438 <para> 438 <link linkend='source-directory'>Source Directory</link> and the
439 Once you are set up through either tarball extraction or a checkout of Git repositories, 439 files for supported BSPs (eg., <filename>meta-intel</filename>) is to
440 you are ready to develop. 440 use <link linkend='git'>Git</link> to create a local copy of the
441 upstream repositories.
442 </note>
441 </para> 443 </para>
442 444
443 <para> 445 <para>
@@ -820,7 +822,8 @@
820 <title>Git</title> 822 <title>Git</title>
821 823
822 <para> 824 <para>
823 The Yocto Project uses Git, which is a free, open source distributed version control system. 825 The Yocto Project makes extensive use of Git,
826 which is a free, open source distributed version control system.
824 Git supports distributed development, non-linear development, and can handle large projects. 827 Git supports distributed development, non-linear development, and can handle large projects.
825 It is best that you have some fundamental understanding of how Git tracks projects and 828 It is best that you have some fundamental understanding of how Git tracks projects and
826 how to work with Git if you are going to use the Yocto Project for development. 829 how to work with Git if you are going to use the Yocto Project for development.
@@ -924,7 +927,7 @@
924 local working branch based on a branch name, 927 local working branch based on a branch name,
925 your local environment matches the "tip" of that development branch 928 your local environment matches the "tip" of that development branch
926 at the time you created your local branch, which could be 929 at the time you created your local branch, which could be
927 different than the files at the time of a similarly named release. 930 different from the files at the time of a similarly named release.
928 In other words, creating and checking out a local branch based on the 931 In other words, creating and checking out a local branch based on the
929 <filename>&DISTRO_NAME;</filename> branch name is not the same as 932 <filename>&DISTRO_NAME;</filename> branch name is not the same as
930 cloning and checking out the <filename>master</filename> branch. 933 cloning and checking out the <filename>master</filename> branch.
@@ -1017,7 +1020,7 @@
1017 will allow the change, and for ultimately pushing the change from your local Git repository 1020 will allow the change, and for ultimately pushing the change from your local Git repository
1018 into the project’s upstream (or master) repository.</para></listitem> 1021 into the project’s upstream (or master) repository.</para></listitem>
1019 <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that 1022 <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that
1020 possibly need staged and committed.</para></listitem> 1023 possibly need to be staged and committed.</para></listitem>
1021 <listitem><para><emphasis><filename>git checkout &lt;branch-name&gt;</filename>:</emphasis> Changes 1024 <listitem><para><emphasis><filename>git checkout &lt;branch-name&gt;</filename>:</emphasis> Changes
1022 your working branch. 1025 your working branch.
1023 This command is analogous to "cd".</para></listitem> 1026 This command is analogous to "cd".</para></listitem>
@@ -1294,10 +1297,9 @@
1294 <listitem><para><emphasis>Board Support Package (BSP) README Files:</emphasis> 1297 <listitem><para><emphasis>Board Support Package (BSP) README Files:</emphasis>
1295 For BSP maintainers of supported BSPs, you can examine 1298 For BSP maintainers of supported BSPs, you can examine
1296 individual BSP <filename>README</filename> files. 1299 individual BSP <filename>README</filename> files.
1297 Alternatively, you can examine the 1300 In addition, some layers (such as the <filename>meta-intel</filename> layer),
1298 <filename>MAINTAINERS</filename> file, which is found in the 1301 include a <filename>MAINTAINERS</filename> file which contains
1299 <filename>meta-intel</filename>, for a list of all supported 1302 a list of all supported BSP maintainers for that layer.
1300 BSP maintainers.
1301 </para></listitem> 1303 </para></listitem>
1302 <listitem><para><emphasis>Search by File:</emphasis> 1304 <listitem><para><emphasis>Search by File:</emphasis>
1303 Using <link linkend='git'>Git</link>, you can enter the 1305 Using <link linkend='git'>Git</link>, you can enter the