View source for Orion/How Tos/Working with git

= Linking to a Git clone already existing on your computer  =

#First [http://www.kernel.org/pub/software/scm/git/docs/git-clone.html clone] a git repository to any location in your local filesystem, you can do with a tool of your choice ([[EGit]], [http://code.google.com/p/msysgit/downloads/list msysgit]...) 
#[[Orion/How Tos/Install Orion on Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]] 
#Create a project and [[Orion/How Tos/Install Orion on Localhost#Linking_to_existing_content|link it]] to the location you used in Step 1. 
#Orion will automatically detect that the project is actually a Git clone (we will probably make it configurable in the future)

= Cloning a Git repository  =

{{warning|Work in progress|This scenario has not been fully implemented yet.}} 

For detailed instruction how to clone repository from GitHub view [[Orion/How Tos/Cloning repository from github]]

#[[Orion/How Tos/Install Orion on Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]] 
#Click the '''Repositories''' link to go to the Git Clones viewer.<br><br>[[Image:Orion Repostories link.png‎]]<br><br>
#Select the Git Clone action.<br><br>[[Image:Git clone action.png]]<br><br> 
#Enter the Git repository URL, and click '''OK'''.<br><br>[[Image:Clone_git_repository_dialog.png]]<br><br>
#The repository will be cloned to a default location in your workspace. If you want to change target location click "Choose target location" and input the new project name or select a directory that already exists in your workspace.<br><br>[[Image:Clone_git_repository_dialog_advanced.png]]
#If authentication is needed you will be prompted for credentials. Which fields are required depends on the specific repository you're connecting to.<br><br>[[Image:Git clone dialog.png]]<br><br>
#When cloning is finished, you'll see the new clone appear in the list:<br><br>[[Image:Git_clone_complete.png]]<br><br>
#Done! You may use the Repositories view to browse remotes and branches of your repository or click the main repository link to view repository contents.<br><br>[[Image:Git_clone_repo_view.png]]<br>

= Using Orion Compare Viewer =
{{warning|Work in progress|This scenario has not been fully implemented yet.}}
Although still in progress , you can now use both in-line and side-by-side compare viewer from Orion.Currently you have to use the viewer HTML directly in your browser and use your file location as the hash of the html. Please also note that the compare viewer container UI will be changed later to fit better layout.
# [[Orion/How_Tos/Install_Orion_on_Localhost#Downloading_and_Running_Orion_on_Localhost|Download and run Orion]] or pull the latest code on both server and client side.
# Link a folder to your  git repository.
# Open a file in the folder by Orion Editor.
# Change something and save the changes.
# Copy the "#/file/your_project/your_file" part from the editor URL as the file location.
# Paste it as the hash value of the viewer HTML(/js/compare/demo/demo-inline.html and /js/compare/demo/demo.html) 
# Below are the format and examples.
* In-line  viewer :
 http://Your_server:8080/js/compare/demo/demo-inline.html#/file/your_project/your_file
 ( e.g.  http://localhost:8080/js/compare/demo/demo-inline.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)<br>[[Image:Howtogit--in-line-viewer.png]]
* Side-by-side viewer(as planned , this viewer will become the merge editor):
 http://Your_server:8080/js/compare/demo/demo.html#/file/your_project/your_file
 ( e.g.  http://localhost:8080/js/compare/demo/demo.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/demo/demo-inline.html)<br>[[Image:Howtogit--side-by-side-viewer1.png]]

= Using Orion Git Status Page =
{{warning|Work in progress|This scenario has not been fully implemented yet.}}
Please note that the section is currently used for developer's discussion.The UI shown below is the developer's UI mockup. The functionality is addressed in a high level.

[[Image:Howtogit--git-status_new.png]]
# Similiar to the compare viewer , the URL format of the git status page is : http://localhost:8080/git-status.html#/file/K/bundles/org.eclipse.orion.client.core/static/js/compare/.<br>Here you pass the directory path to the html.The page will show you the git status under that directory.
# There will be an action somewhere in the navigator to open this page so that user does not have to input the directory as the hash.
# On the left hand , all the unstaged and staged changes are listed up in two areas.
# Clicking on any line will high-light it and the right hand side viewer will show the difference of that file against the Git repo.
# On the unstaged area , hovering on any line pops up two action buttons : compare and stage. The compare action navigates user to a side by side compare viewer. The stage action will stage the file represented by the line.
# On the staged area , hovering on any line pops up two action buttons : compare and unstage. The compare action navigates user to a side by side compare viewer. The unstage action will unstage the file represented by the line.
# The side by side viewer is planned to be upgraded to a compare merge editor post M6.

= Git REST API =

This section was moved to [[Orion/Server_API/Git_API]].

= Bugs, comments, feedback =
If you experience any problems when following the steps above ping z4z4 or SzymonB on [[IRC]] (use #eclipse-orion channel), or [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=e4&component=Orion&version=0.2 open a new bug] right away.


[[Category:Orion|How To]]
[[Category:Orion/How_To|Git]]