This page will help you get started with Git and getting the KIELER sources. For more detailed information, see Git's official documentation. The SVN Crash Course is probably a good place to start. For more in-depth information, see the Git Community Book or the Pro Git book. Furthermore, each office has a copy of another excellent book about Git, so you might as well go ahead and read it. This will help ease you in to some of the more advanced concepts of Git, which are a little hard to understand at first. If everything else fails, Miro and Tim will be more than happy to help you with Git and rant about how excellent of a system it is. For more information on Git Eclipse integration, see the EGit User's Guide.
Checking Out KIELER
KIELER is essentially a large heap of Eclipse plug-ins that aren't easy to find your way through as a new developer. The Overview page has a nice overview of our sub-projects and what plug-ins belong where. This section will tell you how to get the KIELER sources. As for what plug-ins you will actually need to checkout, ask your advisor.
Important Hint for Users Behind Firewalls
The Git protocol runs on port 9418, and SSH runs on port 22. HTTP transfer is also possible in read-only mode, but is not recommended due to its bad performance.
You essentially have the choice of either checking out the KIELER sources using our project sets (preconfigured sets of plug-ins that are automatically imported into your Eclipse environment), or by selecting the plug-ins you want manually.
Checkout Using Team Project Sets
If you need a specific subset of the KIELER plugins, select a suitable project set, copy its URL, and select File - Import - Team - Team Project Set. There are two versions of the project sets:
- Project sets for the Git protocol (read-only; don't take these if you'll be actively developing KIELER code)
- Project sets for the SSH protocol
For access using the SSH protocol you first need to do steps 1 to 3 of the manual checkout section below.
In case you only need read access, omit steps 1 to 4 and copy the following URI instead:
Otherwise, follow these steps:
- If you don't have an SSH key yet, you have to create one. You can do this by:
- Creating one using the command ssh-keygen on the command line. Simply type ssh-keygen, confirm the default destination file ~/.ssh/id_rsa, and choose whether to give a passphrase. If you have a passphrase, you need to enter it whenever you use your SSH key for the first time in a session. You can omit the passphrase, but that makes the key less secure. As result, the tool generates a private key ~/.ssh/id_rsa, which has to be kept secret, and a public key ~/.ssh/id_rsa.pub.
- Using eclipse to generate it. You can find this function under Preferences - General - Network Connections - SSH2 - Key Management.
- Register with Gitorious and upload your public SSH key (Dashboard - Manage SSH keys - Add SSH key).
- Ask a KIELER administrator to add you to the kieler-dev Gitorious team.
- Copy the repository URI firstname.lastname@example.org:kieler/mainline.git into the clipboard.
- Open the Git Repositories view, right-click it, select Paste Repository Path or URI, select ssh connection protocol, Next, select master branch, Next, select destination directory (e.g. /home/<username>/shared/kieler), Finish. Wait for the repository to be downloaded to your computer. Note that the whole history of the repository will be stored in your local filesystem, which is pretty awesome.
- Right-click the Working directory entry in the kieler repository, select Import Projects, Next, select the projects that you want in your workspace, Finish.
In case you already checked out the repository over the read-only git protocol, but you want to be able to commit to the remote repository, open the Git Repositories view, right-click kieler/Remotes/origin, select Configure Push, and change the URI to the ssh variant.
Checking out on the command line is done with the command git clone <URI> <local path>. Instead of the URI you can also use a path to an existing repository, which then creates a clone of that repository.
Adding an Existing Local Repository to EGit
If you have already cloned the KIELER repository and are only looking for a way to import it into EGit, follow these steps:
- Click the button Add an existing local Git Repository to this view in the Git Repositories view and enter the local path.
- Right-click the Working directory entry in the added repository, select Import Projects, Next, select the projects that you want in your workspace, Finish