diff options
Diffstat (limited to 'org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html')
| -rw-r--r-- | org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html | 132 |
1 files changed, 75 insertions, 57 deletions
diff --git a/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html b/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html index d1153f3bc6..4f97a52ab3 100644 --- a/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html +++ b/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html @@ -36,19 +36,19 @@ <h3 id="Configuration">Configuration</h3> <h4 id="Identifying_yourself">Identifying yourself</h4> <p>Whenever the history of the repository is changed (technically, whenever a commit is created), Git keeps track of the user who created that commit. The identification consists of a name (typically a person's name) and an e-mail address. This information is stored in file <code>~/.gitconfig</code> under dedicated keys. - <br/> + <br/> </p> - <p>EGit will ask you for this information when you create your first commit. By default, this dialog is shown only once until you create a new workspace or tick the checkbox "Show initial configuration dialog" on the Git Preference page: </p> + <p>EGit will ask you for this information when you create your first commit. By default, this dialog is shown only once until you create a new workspace or tick the checkbox "Show initial configuration dialog" on the Git Preference page:</p> <p> - <img border="0" src="images/Egit-0.11-initialConfigurationDialog.png"/> + <img border="0" src="images/Egit-0.11-initialConfigurationDialog.png"/> </p> <p>You can also untick "Don't show this dialog again" if you want to see it again later.</p> <p>Instead of using this dialog, you can always change this information using the Git configuration: - <br/> + <br/> </p> <ul> <li>Click - <b>Preferences > Team > Git > Configuration</b> + <b>Preferences > Team > Git > Configuration</b> </li> <li>Click <b>New Entry</b> and enter the key value pairs <code>user.email</code> and <code>user.name</code> @@ -56,42 +56,42 @@ </li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-email.png"/> + <img border="0" src="images/Egit-0.9-getstarted-email.png"/> </p> <p> <img border="0" src="images/Egit-0.9-getstarted-name.png"/> </p> <h4 id="Setting_up_the_Home_Directory_on_Windows">Setting up the Home Directory on Windows</h4> - <p>Add the environment variable <code>HOME</code> to your environment variables. </p> + <p>Add the environment variable <code>HOME</code> to your environment variables.</p> <ol> - <li>In Windows 7, type "enviroment window" at the start menu </li> + <li>In Windows 7, type "enviroment window" at the start menu</li> <li>Select "Edit environment variables for your account"</li> - <li>Click the "New" button. </li> - <li>Enter "HOME" in the name field </li> - <li>Enter "%USERPROFILE%" or some other path in the value field. </li> + <li>Click the "New" button.</li> + <li>Enter "HOME" in the name field</li> + <li>Enter "%USERPROFILE%" or some other path in the value field.</li> <li>Click OK, and OK again. You have just added the Home directory on Windows. <br/> </li> </ol> <p>EGit needs this path for looking up the user configuration (.gitconfig). <code>HOME</code> should point to your home directory e.g. <code>C:\Users\Tom</code>. - <b>Ensure correct case!</b> E.g. <code>C:\users</code> instead of <code>C:\Users</code> may cause problems! + <b>Ensure correct case!</b> E.g. <code>C:\users</code> instead of <code>C:\Users</code> may cause problems! </p> - <p>If the <code>HOME</code> variable is not defined the home directory will be calculated by concatenating <code>HOMEDRIVE</code> and <code>HOMEPATH</code>. </p> - <p>If both <code>HOME</code> and <code>HOMEDRIVE</code> are not defined <code>HOMESHARE</code> will be used. </p> - <p>EGit shows a warning if <code>HOME</code> is not defined explicitly: </p> + <p>If the <code>HOME</code> variable is not defined the home directory will be calculated by concatenating <code>HOMEDRIVE</code> and <code>HOMEPATH</code>.</p> + <p>If both <code>HOME</code> and <code>HOMEDRIVE</code> are not defined <code>HOMESHARE</code> will be used.</p> + <p>EGit shows a warning if <code>HOME</code> is not defined explicitly:</p> <p> <img border="0" src="images/Egit_no_home.png"/> </p> <h3 id="Create_Repository">Create Repository</h3> <ul> - <li>Create a new Java project <code>HelloWorld</code> </li> + <li>Create a new Java project <code>HelloWorld</code></li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-project.png"/> + <img border="0" src="images/Egit-0.9-getstarted-project.png"/> </p> <ul> <li>Select the project, click - <b>File > Team > Share Project</b> + <b>File > Team > Share Project</b> </li> <li>Select repository type <b>Git</b> and click @@ -99,37 +99,37 @@ </li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-share.png"/> + <img border="0" src="images/Egit-0.9-getstarted-share.png"/> </p> <ul> - <li>To configure the Git repository select the new project <code>HelloWorld</code> </li> + <li>To configure the Git repository select the new project <code>HelloWorld</code></li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-create-project.png"/> + <img border="0" src="images/Egit-0.9-getstarted-create-project.png"/> </p> <ul> <li>Click - <b>Create Repository</b> to initialize a new Git repository for the <code>HelloWorld</code> project. If your project already resides in the working tree of an exisiting Git repository the repository is chosen automatically. + <b>Create Repository</b> to initialize a new Git repository for the <code>HelloWorld</code> project. If your project already resides in the working tree of an exisiting Git repository the repository is chosen automatically. </li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-project-created.png"/> + <img border="0" src="images/Egit-0.9-getstarted-project-created.png"/> </p> <ul> <li>Click - <b>Finish</b> to close the wizard. + <b>Finish</b> to close the wizard. </li> <li>The decorator text "[master]" behind the project shows that this project is tracked in a repository on the - <i>master</i> branch and the question mark decorators show that the <code>.classpath</code> and <code>.project</code> and the <code>.settings</code> files are not yet under version control + <i>master</i> branch and the question mark decorators show that the <code>.classpath</code> and <code>.project</code> and the <code>.settings</code> files are not yet under version control </li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-shared-project.png"/> + <img border="0" src="images/Egit-0.9-getstarted-shared-project.png"/> </p> <h3 id="Track_Changes">Track Changes</h3> <ul> <li>Click - <b>Team > Add</b> on the project node + <b>Team > Add</b> on the project node </li> <li>The <i>+</i> decorators show that now the project's files have been added to version control @@ -140,33 +140,33 @@ <b>Team > Ignore</b> or by creating a file <code>.gitignore</code> in the project folder with the following content </li> </ul> - <pre>/bin + <pre>/bin </pre> <ul> - <li>This excludes the <code>bin</code> folder from Git's list of tracked files. </li> + <li>This excludes the <code>bin</code> folder from Git's list of tracked files.</li> <li>Add <code>.gitignore</code> to version control ( <b>Team > Add</b>): </li> </ul> <p> - <img border="0" src="images/Egit-0.11-getstarted-ignore-added.png"/> + <img border="0" src="images/Egit-0.11-getstarted-ignore-added.png"/> </p> <ul> <li>Click - <b>Team > Commit</b> in the project context menu + <b>Team > Commit</b> in the project context menu </li> - <li>Enter a commit message explaining your change, the first line (followed by an empty line) will become the short log for this commit. By default the author and committer are taken from the <code>.gitconfig</code> file in your home directory. </li> + <li>Enter a commit message explaining your change, the first line (followed by an empty line) will become the short log for this commit. By default the author and committer are taken from the <code>.gitconfig</code> file in your home directory.</li> <li>You may click <b>Add Signed-off-by</b> to add a - <i>Signed-off-by:</i> tag. + <i>Signed-off-by:</i> tag. </li> - <li>If you are committing the change of another author you may alter the author field to give the name and email address of the author. </li> + <li>If you are committing the change of another author you may alter the author field to give the name and email address of the author.</li> <li>Click <b>Commit</b> to commit your first change. </li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-commit.png"/> + <img border="0" src="images/Egit-0.9-getstarted-commit.png"/> </p> <ul> <li>Note that the decorators of the committed files changed.</li> @@ -181,28 +181,28 @@ </li> </ul> <p> - <img border="0" src="images/Egit-0.11-getstarted-history1.png"/> + <img border="0" src="images/Egit-0.11-getstarted-history1.png"/> </p> <ul> - <li>Create a new Java class <code>Hello.java</code> and implement it </li> - <li>Add it to version control and commit your change </li> - <li>Improve your implementation and commit the improved class </li> + <li>Create a new Java class <code>Hello.java</code> and implement it</li> + <li>Add it to version control and commit your change</li> + <li>Improve your implementation and commit the improved class</li> <li>The resource history should now show 2 commits for this class</li> </ul> <p> - <img border="0" src="images/Egit-0.9-getstarted-application.png"/> + <img border="0" src="images/Egit-0.9-getstarted-application.png"/> </p> <p> - <img border="0" src="images/Egit-0.11-getstarted-history2.png"/> + <img border="0" src="images/Egit-0.11-getstarted-history2.png"/> </p> <ul> <li>Click the - <b>Compare Mode</b> toggle button in the History View + <b>Compare Mode</b> toggle button in the History View </li> <li>Double click <code>src/Hello.java</code> in the Resource list of the History View to open your last committed change in the Compare View</li> </ul> <p> - <img border="0" src="images/Egit-0.11-getstarted-compare.png"/> + <img border="0" src="images/Egit-0.11-getstarted-compare.png"/> </p> <p> <br/> @@ -222,7 +222,7 @@ <li>create a new repository at GitHub</li> </ul> <p> - <img border="0" src="images/Egit-0.10-github-create-repo.png"/> + <img border="0" src="images/Egit-0.10-github-create-repo.png"/> </p> <p>On the next screen you can see the URLs you may use to access your fresh new repository:</p> <ul> @@ -246,11 +246,11 @@ <h3 id="Eclipse_SSH_Configuration">Eclipse SSH Configuration</h3> <ul> <li>Open the Eclipse - <b>Preferences</b> and ensure that your SSH2 home is configured correctly (usually this is <tt>~/.ssh</tt>) and contains your SSH2 keys + <b>Preferences</b> and ensure that your SSH2 home is configured correctly (usually this is <tt>~/.ssh</tt>) and contains your SSH2 keys </li> </ul> <p> - <img border="0" src="images/Egit-0.10-ssh-preferences.png"/> + <img border="0" src="images/Egit-0.10-ssh-preferences.png"/> </p> <ul> <li>if you don't have SSH keys yet you may generate them on the second tab @@ -264,17 +264,17 @@ <h3 id="Push_Upstream">Push Upstream</h3> <ul> <li>Click - <b>Team > Remote > Push...</b> and copy and paste the SSH URL of your new github repository + <b>Team > Remote > Push...</b> and copy and paste the SSH URL of your new github repository </li> <li>If you are behind a firewall which doesn't allow SSH traffic use the github HTTPS URL instead and provide your github user and password instead of using the uploaded public SSH key. To store your credentials into the Eclipse secure store click - <b>Store in Secure Store</b>. + <b>Store in Secure Store</b>. </li> <li> <b>Note:</b> many HTTP proxies are configured to block HTTP URLs containing a user name, since disclosing a user name in an HTTP URL is considered a security risk. In that case remove the username from the HTTP URL and only provide it in the user field. It will be sent as an HTTP header. </li> </ul> <p> - <img border="0" src="images/Egit-0.10-github-pushurl.png"/> + <img border="0" src="images/Egit-0.10-github-pushurl.png"/> </p> <ul> <li>Click @@ -292,7 +292,7 @@ </li> </ul> <p> - <img border="0" src="images/Egit-0.10-github-push-refspec.png"/> + <img border="0" src="images/Egit-0.10-github-push-refspec.png"/> </p> <ul> <li>Click @@ -300,7 +300,7 @@ </li> </ul> <p> - <img border="0" src="images/Egit-0.10-github-push-preview.png"/> + <img border="0" src="images/Egit-0.10-github-push-preview.png"/> </p> <ul> <li>Click @@ -311,7 +311,7 @@ <li>The next dialog reports the result of the push operation.</li> </ul> <p> - <img border="0" src="images/Egit-0.10-github-pushresult.png"/> + <img border="0" src="images/Egit-0.10-github-pushresult.png"/> </p> <ul> <li>Point your browser at your GitHub repository to see that your new repository content has arrived</li> @@ -322,18 +322,18 @@ <p> <br/> </p> - <h2 id="EGit_Tutorial">EGit Tutorial</h2> + <h2 id="EGit_Tutorial_.28EclipseCon_March_2011.29">EGit Tutorial (EclipseCon March 2011)</h2> <p>You may want to learn how to work with EGit and Gerrit Code Review by going through the - <a href="http://www.eclipsecon.org/2011/sessions/?page=sessions&id=2035" target="egit_external">EGit tutorial we held at EclipseCon 2011</a>. + <a href="http://www.eclipsecon.org/2011/sessions/?page=sessions&id=2035" target="egit_external">EGit tutorial we held at EclipseCon America 2011</a>. </p> <h3 id="Installation_and_Configuration">Installation and Configuration</h3> - <p>The tutorial was developed using EGit 0.11 so you should use at least this version. Newer versions may provide an easier way to do certain steps, look at the + <p>This tutorial was developed using EGit 0.11 so you should use at least this version. Newer versions may provide an easier way to do certain steps, look at the <a href="http://wiki.eclipse.org/EGit/FAQ#Where_can_I_find_older_releases_of_EGit.3F" target="egit_external">EGit "New and Noteworthy" documentation</a>. </p> <p>Best you go through the exercises using the Gerrit-in-a-zip you may download from TODO. See exercise 9 to learn how to use that.</p> <p>The egit-training repository is also available on - <a href="http://egit.eclipse.org/" target="egit_external">http://egit.eclipse.org/</a>. + <a href="http://egit.eclipse.org/" target="egit_external">http://egit.eclipse.org/</a>. You may clone it from there using </p> <pre>git://egit.eclipse.org/egit-training.git @@ -341,7 +341,7 @@ <p>More details are given in</p> <ul> <li>Exercise 1: - <a href="https://docs.google.com/document/d/1Uxq59vCcWqK-hPb5CHQcR97A%20mJehj6Rn0ScTnih2tyU/edit?hl=en_US" target="egit_external">Installation and configuration</a> + <a href="https://docs.google.com/document/d/1Uxq59vCcWqK-hPb5CHQcR97AmJehj6Rn0ScTnih2tyU/edit?hl=en_US" target="egit_external">Installation and configuration</a> </li> <li>Exercise 9: <a href="https://docs.google.com/document/d/1JDdge66iEN5BvBMSETtO3u5eUHmsuXLCoEc25HQqOcE/edit?hl=en_US" target="egit_external">Starting demo Gerrit server</a> @@ -373,6 +373,24 @@ </ul> <p> <br/> + </p> + <h2 id="EGit_Tutorial_.28EclipseCon_Europe_Nov_2011.29">EGit Tutorial (EclipseCon Europe Nov 2011)</h2> + <p>We held this tutorial + <a href="http://www.eclipsecon.org/europe2011/sessions/eclipse-hackers-guide-git-universe" target="egit_external">"Eclipse Hacker's Guide to the Git Universe"</a> at EclipseCon Europe on Nov 2, 2011. + </p> + <p>This tutorial was developed using EGit 1.2-SNAPSHOT so you should use at least this version. + Newer versions may provide an easier way to do certain steps, look at the + <a href="http://wiki.eclipse.org/EGit/FAQ#Where_can_I_find_older_releases_of_EGit.3F" target="egit_external">EGit "New and Noteworthy" documentation</a>. + </p> + <p>The egit-training repository is also available on + <a href="http://egit.eclipse.org/" target="egit_external">http://egit.eclipse.org/</a>. + You may clone it from there using + </p> + <pre>git://egit.eclipse.org/egit-training.git +</pre> + <h3 id="Exercises_2">Exercises</h3> + <p>Find slides and exercises + <a href="https://docs.google.com/#folders/0B4F_gjXVrHZVYmYzN2EwMmQtMmQyNC00NmI4LWFmODQtYjk4ZGVlMTI0NGJl" target="egit_external">here</a> </p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> |