Revision as of 16:33, 22 June 2010

Amarok is now developed in a Git repository instead of SVN. This was done to help get into place all the needed infrastructure to convert all of KDE, including documentation.

Crucial Step 0

For Windows you will need to follow some more steps. Found here.

git config --global user.name "Your Legal First and Last Name Here"
git config --global user.email [email protected]

Run these commands before you even ponder ever in your life pushing to a Git repo.

Getting started with git

Depending on whether you simply want to test and follow Amarok development, write the occasional patch, or are an Amarok developer, the steps to use the repo are different.

Follow and test the latest development code

git clone git://git.kde.org/amarok/amarok

This creates an 'amarok' directory. cd into that and use it like normal. And when you want to update:

git pull

will download the new changes.

Patch Contributions

This is still a work in progress, as we work on getting ReviewBoard set up. In the meantime, hold on to any patches, or email them to [email protected] -- just be sure to follow the thread to ensure that it doesn't get lost :-)

If you want to use a local clone for working on bug fixes or features, do the following:

Create a branch for each new feature of bug fix you want to work on:

git branch my_feature_branch

Switch to the new branch:

git checkout my_feature_branch

Work, fix that bug or add the feature...

...work on this checkout - follow the normal development workflow...

Commit it to your local checkout:

git commit -a

You can follow the main development branch easily by adding it as remote branch:

git remote add upstream git://git.kde.org.org/amarok/amarok

Update by pulling from the remote:

git pull --rebase upstream master

Remember to use one branch per feature/bug fix!

Amarok Developers

Account Setup

If you don't already have a SSH account to the KDE SVN, please file a sysadmin bug on http://bugs.kde.org and provide your logon and your SSH pub key.

Setup Amarok Clone

A basic local clone for development work that allows push access can be created by running:

git clone [email protected]:amarok/amarok

This will place a clone in the "amarok" subdirectory of the current folder.

Once you have a KDE development SSH account, you can create your own server-side clone of the Amarok repository and store your changes there. Others can then pull from your repository or add your repository as a remote.

Please note that personal clones are using KDE infrastructure and meant for KDE-relevant work, and as such you cannot change the access policy that allows everyone to read these clones (but you can change who can write to them, as explained below). Please do not create clones to e.g. make changes to customize code for your company. If you want to do this, host your clone on Gitorious.org or GitHub.com instead.

To create a personal clone, run the following command, substituting your KDE username and a reponame of your choice, *without* a trailing ".git":

ssh [email protected] clone amarok/amarok amarok/users/[username]/[reponame]

After that, you will have a fully functioning repository of your own at git://git.kde.org/amarok/users/[username]/[reponame] or [email protected]:amarok/users/[username]/[reponame] for read-only and push URLs, respectively.

You can delete this repository at any time by running the "rmrepo" command:

ssh [email protected] rmrepo amarok/users/[username]/[reponame]

Rights Management

When your clone is created, it is setup to allow all KDE developers push access to it. This is in keeping with KDE's everyone-can-write-anywhere philosophy. You are strongly encouraged to keep this default.

However, we understand that at times you may want to ensure that the work you are doing is not modified by anyone else until you are finished, or reach a milestone, or some such thing.

As such, you can adjust who can write to your cloned repository.

To see the current permissions, use the "getperms" command:

ssh [email protected] getperms amarok/users/mitchell/testrepo
RW = @all

@all is a special groupname that indicates all KDE developers. It is the only special name allowed in the permissions.

To modify them, create a file named anything you like -- I'll use "myperms". In "myperms" enter those that should have RW access by their KDE user account name. The RW statements are cumulative, or can specify multiple user accounts on one line:

RW = hein bcooskley
RW = toma

At the end of this, the total push permissions will be comprised of *you* (the creator of the clone, in my case "mitchell"), hein, bcooskley *and* toma. Note that *you* are the only one that can push and delete new branches and tags; the other contributors only have push access. In other words, you are your own release manager for your clone.

Now, use the "setperms" command to set the permissions, passing in the file you created:

ssh [email protected] setperms amarok/users/mitchell/testrepo < myperms
New perms are:
RW = hein bcooksley
RW = toma

Basic Development

90% of the time this is all that is needed:

git pull --rebase
#hack, compile, build. It works!
git status #to check if you want to commit all the modified files
git commit -a
git log
git push

git pull --rebase downloads the latest changes. The --rebase option takes any unpushed local commits and applies them to the latest code, moving it to the top of the history. It is the equivalent of git pull; git rebase origin/master. See the "1. Rebase" section of Shipping Quality Code for a good explanation of what rebase does.

If you have uncommited changes you can not rebase. Instead you can git stash, do the rebase, and then git stash apply.

git status will tell you what files are modified. If you created a new file, use git add on it to "track" it. If there are some junk files, you can add a regexp to .gitignore in the root.

git commit -a will commit all unmodified files. You can use git add and then simply git commit instead if you wish to commit only certain files.

Use git log to review the local unpushed commits. Possibly also useful is git diff origin/master, which will give you a diff between the current checkout and what is in the central repo.

git push pushes all the local commits to the central repo.

Follow remote feature branch

With git, feature branches are cheap and easy. Here's how to follow a feature branch someone else has already setup.

Remember that you can't push to git:// URL's when picking what URL to use.

git remote add jeff git://git.kde.org/amarok/users/mitchell/pudaction.git
git remote update
git branch -a
git branch jeff-pud jeff/pudaction-removal
git checkout jeff-pud
#and later you want to switch back to the mainline
git checkout master

git remote add adds a new remote named 'jeff' with the given URL. Think of remotes like bookmarks: you could always just explicitly pull from a URL instead.

git remote update downloads all the remotes you have without merging them, including the remote you just defined. This is a handy command if you're tracking multiple remotes.

git branch -a this lists all the branches you have, including the remote branches. Find the new branch you want to look at.

git branch this command creates a local branch called 'jeff-pud' that tracks the remote branch 'pud-action/pudaction-removal'. You figured out the name of the latter in the previous command.

git checkout is how you switch between branches.

Recommended reading  =

The Git Parable Background information that will help you understand git and distributed revision control systems in general
Git to SVN crash course 5 minute introduction to git for experienced SVN users
Shipping Quality Code with Git Guide to cleanup before a push
Git for Computer Scientists Quick introduction to git internals for people who are not scared by words like Directed Acyclic Graph.
Linus Torvalds on Git Why git? answered by the man that started it.
Git Ready! Learn git one commit at a time
Git Community Book An online book covering git from the basics to some advanced features
Git Magic Covers some concepts and common usage patterns
Zack Rusin's git cheat sheet
Git cheat sheet Yet another git cheat sheet
git by example git command reference and explanation
Git Quick Reference Yet another reference of the most used git commands

Todo for this doc

creating feature branches
history manipulation. rebase -i, commit --append, and what to do when things go wrong. Probably its own page.
merging with Development/Tutorials/Git