diff options
Diffstat (limited to 'org.eclipse.egit.doc/help/EGit/User_Guide/Managing-Repositories.html')
| -rw-r--r-- | org.eclipse.egit.doc/help/EGit/User_Guide/Managing-Repositories.html | 231 |
1 files changed, 0 insertions, 231 deletions
diff --git a/org.eclipse.egit.doc/help/EGit/User_Guide/Managing-Repositories.html b/org.eclipse.egit.doc/help/EGit/User_Guide/Managing-Repositories.html deleted file mode 100644 index 0ea3d446c8..0000000000 --- a/org.eclipse.egit.doc/help/EGit/User_Guide/Managing-Repositories.html +++ /dev/null @@ -1,231 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>EGit User Guide - Managing Repositories</title> - <link type="text/css" rel="stylesheet" href="../../book.css"/> - </head> - <body> - <table class="navigation" style="width: 100%;" border="0" summary="navigation"> - <tr> - <th style="width: 100%" align="center" colspan="3">Managing Repositories</th> - </tr> - <tr> - <td style="width: 20%" align="left"> - <a href="Patches.html" title="Patches"> - <img alt="Previous" border="0" src="../../images/prev.gif"/> - </a> - </td> - <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right"> - <a href="Updating-This-Document.html" title="Updating This Document"> - <img alt="Next" border="0" src="../../images/next.gif"/> - </a> - </td> - </tr> - <tr> - <td style="width: 20%" align="left" valign="top">Patches</td> - <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Updating This Document</td> - </tr> - </table><hr/> - <h1 id="Managing_Repositories">Managing Repositories</h1> - <p>The "Git Repositories View" is the primary UI element to facilitate working with multiple Repositories simultaneously (i.e. within one Eclipse Workspace).</p> - <p>This view can be opened using the menu path - - <br/> - - <b>Windows > Show View > Other... > Git > Git Repositories</b> - </p> - <p>It is also part of the "Git Repository Exploring" perspective available using menu path - - <br/> - - <b>Window > Open Perspective > Other... > Git Repository Exploring</b> - </p> - <p>If you already have projects in your workspace which are shared with a Git Repository, you can use - - <br/> - - <b>Show In... > Git Repositories</b> - </p> - <p>on any resource to open the view:</p> - <p> - <img border="0" src="images/RepoMgrShowIn.png"/> - </p> - <h2 id="Adding_Repositories_to_the_Git_Repositories_View">Adding Repositories to the Git Repositories View</h2> - <p>Initially, the Git Repositories View is empty. In order to add Repositories to it, there are several options:</p> - <ol> - <li>Cloning a Repository and having the cloned Repository added to the view automatically</li> - <li>Adding a Repository from the Local File System manually</li> - <li>Adding a Repository by pasting a Git Repository path to the view</li> - </ol> - <h3 id="Cloning_a_Repository_2">Cloning a Repository</h3> - <p>In order to clone a Repository, refer to - <a href="Starting-from-existing-Git-Repositories.html#Cloning_a_Repository">Cloning remote Repositories</a>. After a successful clone operation, the newly cloned Repository should appear in the Git Repositories View automatically. - </p> - <p>You can also use the - <b>Clone a Git Repository</b> button from the view's toolbar to start the Clone wizard: - </p> - <p> - <img border="0" src="images/RepoMgrCloneRepositoryIcon.png"/> - </p> - <p>Please refer to - <a href="Starting-from-existing-Git-Repositories.html#Cloning_a_Repository">Cloning remote Repositories</a> about how to use the wizard. - </p> - <h3 id="Adding_a_Repository_manually">Adding a Repository manually</h3> - <p>You can add a Repository from your local file system to the Git Repositories View without cloning it. This can be helpful if you are setting up a new Eclipse workspace and want to re-use your Git Repositories. Use the - <b>Add an existing Git Repository</b> button from the view's toolbar: - </p> - <p> - <img border="0" src="images/RepoMgrAddRepositoryIcon.png"/> - </p> - <p>A dialog will appear prompting you for a directory of your local file system. After selecting the correct directory, you can hit the - <b>Search</b> button to see a list of Git Repositories in this directory. You can then select some or all found Repositories and add them to the view using - <b>OK</b>: - </p> - <p> - <img border="0" src="images/RepoMgrSearchDialog.png"/> - </p> - <h3 id="Adding_a_Repository_using_copy_and_paste">Adding a Repository using copy and paste</h3> - <p>As a shortcut,it is also possible to just paste the local file system path of a Git Repository from the clipboard to this view. In order to do so, copy the path of a Git Repository (the path to the repository's .git folder) to the clipboard, then open the context menu on the view panel (i.e. not selecting a node):</p> - <p> - <img border="0" src="images/RepoMgrPasteRepositoryPath.png"/> - </p> - <p>or simply perform - <b>Edit > Paste</b> from the main menu (or the corresponding keyboard shortcut). If the clipboard content is not suitable, an error popup will be displayed, otherwise the added Repository should appear automatically. - </p> - <p>After the view has been populated with some Repositories, it should look like this:</p> - <p> - <img border="0" src="images/RepoMgrViewWithRepos.png"/> - </p> - <h2 id="Structure_of_the_Git_Repositories_View">Structure of the Git Repositories View</h2> - <p>The following screenshot shows the topmost two levels of the Git Repositories View:</p> - <p> - <img border="0" src="images/RepoMgrTopLevelNodes.png"/> - </p> - <p>The root node represents the Repository itself. The node text indicates the name of the Repository and it's location in the local file system. The "Branches" and "Tags" nodes allow browsing and manipulation of tags and branches. The "Symbolic References" node lists other references which are not branches or tags, most notably the "HEAD" symbolic reference.</p> - <p>The "Working directory" node displays the location and structure of the working directory on the local file system (only in case of a development, or non-bare Repository, for bare Repositories, this node is always a leaf).</p> - <p>Finally, the "Remotes" node allows browsing and manipulating the remote configurations used for Fetch and Push.</p> - <h2 id="Functions_of_the_Git_Repositories_View">Functions of the Git Repositories View</h2> - <h3 id="Project_Import">Project Import</h3> - <p>In order to work with the contents of a Git Repository, its files and folders must be imported into the Eclipse workspace in the form of projects. While the Git Clone wizard allows to do such imports directly after cloning, the Git Repositories View allows to trigger project imports independently of the clone operation.</p> - <p>The "Import Projects..." context menu is available on the "Repository" node as well as on any "Folder" node within the "Working Directory" node and the "Working Directory" node itself:</p> - <p> - <img border="0" src="images/RepoMgrImportNodes.png"/> - </p> - <p>The rationale for offering the - <b>Import Projects...</b> action on several nodes is that some of the wizards used for importing projects can take the file system directory into account, for example the - <b>Import Existing Projects</b> wizard. If the import is started from the "Repository" or the "Working Directory" node, the working directory of the repository is set as context, otherwise the directory corresponding to the currently selected "Folder" node. - </p> - <p>The details of project import are discussed elsewhere.</p> - <h3 id="Branch_and_Tag_Support">Branch and Tag Support</h3> - <p>The "Branches" node allows to create, browse, checkout and delete local and remote branches. The "Tags" node allows for browsing and checking out of tags. - For better readability, branches are organized in two sub-nodes for local and remote branches, respectively, and only the shortened names are displayed, e.g. instead of <tt>"refs/heads/master"</tt> you would find an entry <tt>"master"</tt> under the "Local Branches" node, instead of <tt>"refs/remotes/origin/master"</tt> the shortened name <tt>"origin/master"</tt> is displayed under the "Remote Branches" node. Similarly, tag names are shortened by omitting the <tt>"refs/tags/"</tt> prefix:</p> - <p> - <img border="0" src="images/RepoMgrBranchesAndTags.png"/> - </p> - <h4 id="Check-out_of_Branches_and_Tags">Check-out of Branches and Tags</h4> - <p>Branches and tags can be checked out by either double-clicking on the respective node or by selecting the corresponding context menu entry.</p> - <h4 id="Creation_and_Deletion_of_Branches">Creation and Deletion of Branches</h4> - <p>Local branches can be created using a simple wizard. After selecting the corresponding context menu entry (available on the "Branches", the "Local Branches", and on any "Branch" node), you are asked to enter a source branch and a name for the new branch. Depending on whether you have called the wizard from a "Branch" node, the source branch drop-down will be pre-selected with either the selected branch or the currently checked-out branch:</p> - <p> - <img border="0" src="images/RepoMgrCreateBranch.png"/> - </p> - <p>You can change the source branch using the drop-down. By default, the newly created branch will be checked out after creation. Deselect the corresponding checkbox on the wizard if you don't want this to happen.</p> - <p>Branch deletion is done using the corresponding context menu entry.</p> - <h4 id="Determining_the_Checked-out_Branch">Determining the Checked-out Branch</h4> - <p>There are two ways to determine which branch or tag is currently checked out: the checked out branch/tag node is decorated with a little check mark and the "HEAD" entry under the "Symbolic References" node shows the (full) name of the checked out branch:</p> - <p> - <img border="0" src="images/RepoMgrCheckedOutBranch.png"/> - </p> - <h4 id=".22Detached.22_HEAD">"Detached" HEAD</h4> - <p>If HEAD is "detached", i.e. is not pointing to the tip of a local branch but to a commit or tag, then none or several "checked-out" markers may appear in the tree, since any number of remote branch or tags may point to the currently checked out commit. The state you are in while your HEAD is detached is not recorded by any branch (which is natural --- you are not on any branch).</p> - <h3 id="Browsing_the_Working_Directory">Browsing the Working Directory</h3> - <p>The "Working Directory" node visualizes the local file system structure of the Git Repository. It is also possible to open a text editor on the files:</p> - <p> - <img border="0" src="images/RepoMgrOpenTextEditor.png"/> - </p> - <p>Also, on all file and folder nodes as well as on the "Repository" node, an option is offered to copy the (file-system specific) path to the clipboard. This is sometimes useful when the path is needed, for example to open a directory using a file browser or to copy and paste Repositories between view instances (see above about how to add Repositories to the view). The - <b>Copy to Clipboard</b> action is also available using - <b>Edit > Copy</b> (or the corresponding keyboard shortcut). - </p> - <h3 id="Repository_Configuration">Repository Configuration</h3> - <p>Integration with the generic "Properties" view in Eclipse allows to view and edit the Git Configuration (global and repository-specific configuration). If the "Properties" view is open, it is updated automatically when a "Repository" node is selected. For convenience, an - <b>Open Properties view</b> action is provided in the context menu: - </p> - <p> - <img border="0" src="images/RepoMgrPropertiesView.png"/> - </p> - <h3 id="Remote_Repositories">Remote Repositories</h3> - <p>The "Remotes" node allows for browsing and editing Remote configurations. Each Remote configuration has a name and either a Push Specification, a Fetch Specification, or both. If a "Remote Configuration" node or any of its children is selected, the - <b>Properties</b> view will show a summary of the Remote configuration. In this example: there is a Remote configuration named "origin" which only has a Fetch Specification, but no Push Specification: - </p> - <p> - <img border="0" src="images/RepoMgrRemoteConfig.png"/> - </p> - <p>Menu actions are provided to add, configure, and remove Remote configurations and Fetch and Push Specifications. </p> - <h4 id="Direct_Fetch_and_Push_Support">Direct Fetch and Push Support</h4> - <p>It is possible to execute fetch and push directly (i.e. without a wizard) on the respective "Fetch" and "Push" nodes:</p> - <p> - <img border="0" src="images/RepoMgrSimpleFetch.png"/> - </p> - <p>Note that the fetch or push operation will be executed immediately in an asynchronous job; on completion you will get a confirmation pop-up displaying the fetch result.</p> - <h4 id="Adding_a_Remote_Configuration">Adding a Remote Configuration</h4> - <p>This is done using a context menu action on the "Remotes" node. A wizard is started asking for the name of the new configuration and whether to configure Fetch, Push, or both:</p> - <p> - <img border="0" src="images/RepoMgrNewRemote.png"/> - </p> - <p>The details of Remote configuration are explained elsewhere. Upon completion, the new Remote configuration will be visible:</p> - <p> - <img border="0" src="images/RepoMgrRemoteCreated.png"/> - </p> - <h4 id="Changing_Remote_Configurations">Changing Remote Configurations</h4> - <p>It is also possible to add, remove, or change Fetch/Push Specifications for an existing Remote configuration using the context menu.</p> - <h2 id="Refresh">Refresh</h2> - <p>The view is auto-refreshed periodically. The - <b>Refresh</b> button in the toolbar allows to trigger an immediate refresh: - </p> - <p> - <img border="0" src="images/RepoMgrRefresh.png"/> - </p> - <h2 id="Link_with_Selection">Link with Selection</h2> - <p>If the - <b>Link with selection</b> toggle is enabled, the file or folder corresponding to the current workbench selection will be displayed automatically: - </p> - <p> - <img border="0" src="images/RepoMgrLinkWithSelection.png"/> - </p> - <h2 id="Bare_Repositories">Bare Repositories</h2> - <p>"Bare" Git Repositories (as opposed to "development" or "standard" Repositories) have no working directory by definition, so all actions related to the working directory (check-out, project import, browsing the working directory) are not available for such Repositories. The "Bare-ness" of a Repository is visualized on the "Working Directory" node, which is always a leaf:</p> - <p> - <img border="0" src="images/RepoMgrBareRepository.png"/> - </p> - <h2 id="Removing_Repositories_from_the_Git_Repositories_View">Removing Repositories from the Git Repositories View</h2> - <p>This is offered as a menu action on the "Repository" node. Note that this does not delete the Repository, but just removes the node from the view. If there are projects in the workspace which are located in the working directory of the Repository, the user will be prompted to confirm deletion of these projects from the Eclipse workspace.</p><hr/> - <table class="navigation" style="width: 100%;" border="0" summary="navigation"> - <tr> - <td style="width: 20%" align="left"> - <a href="Patches.html" title="Patches"> - <img alt="Previous" border="0" src="../../images/prev.gif"/> - </a> - </td> - <td style="width: 60%" align="center"> - <a href="User-Guide.html" title="EGit User Guide"> - <img alt="EGit User Guide" border="0" src="../../images/home.gif"/> - </a> - </td> - <td style="width: 20%" align="right"> - <a href="Updating-This-Document.html" title="Updating This Document"> - <img alt="Next" border="0" src="../../images/next.gif"/> - </a> - </td> - </tr> - <tr> - <td style="width: 20%" align="left" valign="top">Patches</td> - <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Updating This Document</td> - </tr> - </table> - </body> -</html>
\ No newline at end of file |