diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-09 14:43:37 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:56 +0100 |
commit | 78ec6f7c076e95448ca0f136031be2042f72a5b2 (patch) | |
tree | 0d61114a7cd1ef2471d338faf96d7ce308290122 /documentation/dev-manual/dev-manual-newbie.xml | |
parent | f1c2fea3f82c4b63a22d280f508dd32559d0cebe (diff) | |
download | poky-78ec6f7c076e95448ca0f136031be2042f72a5b2.tar.gz |
dev-manual: Edits to "Basic Commands" section.
(From yocto-docs rev: 3cd5c68d610d7ec2fe4c8d1ad64b05833bb31425)
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/dev-manual-newbie.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index b42fafd770..a365e07f1d 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -992,7 +992,7 @@ | |||
992 | </para> | 992 | </para> |
993 | 993 | ||
994 | <para> | 994 | <para> |
995 | If you don’t know much about Git, we suggest you educate | 995 | If you don’t know much about Git, you should educate |
996 | yourself by visiting the links previously mentioned. | 996 | yourself by visiting the links previously mentioned. |
997 | </para> | 997 | </para> |
998 | 998 | ||
@@ -1007,24 +1007,24 @@ | |||
1007 | <listitem><para><emphasis><filename>git clone</filename>:</emphasis> Creates a clone of a repository. | 1007 | <listitem><para><emphasis><filename>git clone</filename>:</emphasis> Creates a clone of a repository. |
1008 | During collaboration, this command allows you to create a local repository that is on | 1008 | During collaboration, this command allows you to create a local repository that is on |
1009 | equal footing with a fellow developer’s repository.</para></listitem> | 1009 | equal footing with a fellow developer’s repository.</para></listitem> |
1010 | <listitem><para><emphasis><filename>git add</filename>:</emphasis> Adds updated file contents | 1010 | <listitem><para><emphasis><filename>git add</filename>:</emphasis> Stages updated file contents |
1011 | to the index that | 1011 | to the index that |
1012 | Git uses to track changes. | 1012 | Git uses to track changes. |
1013 | You must add all files that have changed before you can commit them.</para></listitem> | 1013 | You must stage all files that have changed before you can commit them.</para></listitem> |
1014 | <listitem><para><emphasis><filename>git commit</filename>:</emphasis> Creates a “commit” that documents | 1014 | <listitem><para><emphasis><filename>git commit</filename>:</emphasis> Creates a "commit" that documents |
1015 | the changes you made. | 1015 | the changes you made. |
1016 | Commits are used for historical purposes, for determining if a maintainer of a project | 1016 | Commits are used for historical purposes, for determining if a maintainer of a project |
1017 | will allow the change, and for ultimately pushing the change from your local Git repository | 1017 | 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> | 1018 | into the project’s upstream (or master) repository.</para></listitem> |
1019 | <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that | 1019 | <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that |
1020 | possibly need to be added and committed.</para></listitem> | 1020 | possibly need staged and committed.</para></listitem> |
1021 | <listitem><para><emphasis><filename>git checkout <branch-name></filename>:</emphasis> Changes | 1021 | <listitem><para><emphasis><filename>git checkout <branch-name></filename>:</emphasis> Changes |
1022 | your working branch. | 1022 | your working branch. |
1023 | This command is analogous to “cd”.</para></listitem> | 1023 | This command is analogous to "cd".</para></listitem> |
1024 | <listitem><para><emphasis><filename>git checkout –b <working-branch></filename>:</emphasis> Creates | 1024 | <listitem><para><emphasis><filename>git checkout –b <working-branch></filename>:</emphasis> Creates |
1025 | a working branch on your local machine where you can isolate work. | 1025 | a working branch on your local machine where you can isolate work. |
1026 | It is a good idea to use local branches when adding specific features or changes. | 1026 | It is a good idea to use local branches when adding specific features or changes. |
1027 | This way if you don’t like what you have done you can easily get rid of the work.</para></listitem> | 1027 | This way if you do not like what you have done you can easily get rid of the work.</para></listitem> |
1028 | <listitem><para><emphasis><filename>git branch</filename>:</emphasis> Reports | 1028 | <listitem><para><emphasis><filename>git branch</filename>:</emphasis> Reports |
1029 | existing local branches and | 1029 | existing local branches and |
1030 | tells you the branch in which you are currently working.</para></listitem> | 1030 | tells you the branch in which you are currently working.</para></listitem> |
@@ -1037,13 +1037,16 @@ | |||
1037 | repository and places it in your local Git repository. | 1037 | repository and places it in your local Git repository. |
1038 | You use this command to make sure you are synchronized with the repository | 1038 | You use this command to make sure you are synchronized with the repository |
1039 | from which you are basing changes (.e.g. the master branch).</para></listitem> | 1039 | from which you are basing changes (.e.g. the master branch).</para></listitem> |
1040 | <listitem><para><emphasis><filename>git push</filename>:</emphasis> Sends all your local changes you | 1040 | <listitem><para><emphasis><filename>git push</filename>:</emphasis> |
1041 | have committed to an upstream Git repository (e.g. a contribution repository). | 1041 | Sends all your committed local changes to an upstream Git |
1042 | The maintainer of the project draws from these repositories when adding your changes to the | 1042 | repository (e.g. a contribution repository). |
1043 | project’s master repository.</para></listitem> | 1043 | The maintainer of the project draws from these repositories |
1044 | when adding changes to the project’s master repository or | ||
1045 | other development branch. | ||
1046 | </para></listitem> | ||
1044 | <listitem><para><emphasis><filename>git merge</filename>:</emphasis> Combines or adds changes from one | 1047 | <listitem><para><emphasis><filename>git merge</filename>:</emphasis> Combines or adds changes from one |
1045 | local branch of your repository with another branch. | 1048 | local branch of your repository with another branch. |
1046 | When you create a local Git repository, the default branch is named “master”. | 1049 | When you create a local Git repository, the default branch is named "master". |
1047 | A typical workflow is to create a temporary branch for isolated work, make and commit your | 1050 | A typical workflow is to create a temporary branch for isolated work, make and commit your |
1048 | changes, switch to your local master branch, merge the changes from the temporary branch into the | 1051 | changes, switch to your local master branch, merge the changes from the temporary branch into the |
1049 | local master branch, and then delete the temporary branch.</para></listitem> | 1052 | local master branch, and then delete the temporary branch.</para></listitem> |