Latest revision as of 12:32, 1 June 2024

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.

Amarok/Development/Git contains the most up-to-date information on Amarok related git topics. KDE Git page also provides more details.

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/clones/amarok.git/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.

@@ Line 1: / Line 1: @@
-= Getting started with git  =
-== Recommended reading  ==
+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. <br>
-[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable:] ''Background information that will help you understand git and distributed revision control systems in general''<br> [http://git.or.cz/course/svn.html Git to SVN crash course] ''5 minute introduction to git for experienced SVN users''
+[https://community.kde.org/Amarok/Development/Git Amarok/Development/Git] contains the most up-to-date information on Amarok related git topics. [https://community.kde.org/Infrastructure/Git KDE Git page] also provides more details.
-== Getting started for people wanting to track Amarok development  ==
+=== Basic Development  ===
-  git clone git://gitorious.org/amarok/amarok.git
+% 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
-This creates an 'amarok' directory. cd into that and use it like normal. And when you want to update:
+''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 [http://magazine.redhat.com/2008/05/02/shipping-quality-code-with-git/ 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 pull
+''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.
-will download the new changes.
+''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.
-== Patch Contributors ==
+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.
-You can use the method above, make your changes, then do 'git diff' to create a patch like normal. Or you could use the following rules to create your own fork of Amarok with the additions you would like to request to merge. This makes it easier for Amarok Developers to track your changes and is better for more complicated patches.
-*Make sure you have created your account on Gitorious and are logged in. Go to the project you want to clone (e.g. Amarok - http://gitorious.org/amarok) and select the branch which you want to clone (in this case Amarok - Mainline which is the master branch).
+''git push'' pushes all the local commits to the central repo.
-*After selecting the branch you can click "Clone this repository on Gitorious". Give your branch a name and you'll be taken to the page of your newly created clone. On this page you find two git urls: one to publicly clone the repository and the "Push url: [email protected]:~yourname/amarok/yourname-clone.git.
-*Clone the push url to start working on your clone:
- git clone [email protected]:~yourname/amarok/yourname-clone.git
- ...work on this checkout - follow the normal development workflow...
- push your changes to gitorious
-*Create a merge request on gitorious by going to your clone page and selecting "Request merge" in the menu on the right.
-== Amarok Developers  ==
+= 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.
-=== gitorious.org account setup ===
+Remember that you can't push to git:// URL's when picking what URL to use.
-*Create an account on [http://gitorious.org gitorious.org] the git hosting service used by Qt and now Amarok.
+ git remote add jeff git://git.kde.org/clones/amarok.git/mitchell/pudaction.git
-*On your user page, (that's at http://gitorious.org/~your_nick) click on "Manage SSH keys" and add your SSH key.
+ 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
-People with KDE-SVN accounts als should do the following:
+''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.
-*Again from the user page, click on "Manage aliases" and add any email addresses you've ever used in KDE SVN. This way any commits you've made in the past are tracked back to you. If your gitorious email address is the only one you ever used, then this step isn't needed.
+''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.
-*Request one of the kde-developers admins to add your username to the group (the same rules apply as KDE SVN account requests). This will give you push rights to Amarok. Lydia, Ian and Jeff are all admins.
-=== Setup Amarok Clone ===
+''git branch -a'' this lists all the branches you have, including the remote branches. Find the new branch you want to look at.
-Gitorious has one address for cloning, and another for pushing. The pushing address can be used for cloning, so the easy thing to do is just use that.
+''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 clone git@gitorious.org:amarok/amarok.git
+''git checkout'' is how you switch between branches.
-This will create a directory 'amarok'. cd into that and start developing!
+ Recommended reading  =
-=== Basic Development ===
+*[http://tom.preston-werner.com/2009/05/19/the-git-parable.html The Git Parable] ''Background information that will help you understand git and distributed revision control systems in general''
+*[http://git.or.cz/course/svn.html Git to SVN crash course] ''5 minute introduction to git for experienced SVN users''
+*[http://www.redhatmagazine.com/2008/05/02/shipping-quality-code-with-git/ Shipping Quality Code with Git] ''Guide to cleanup before a push''
+*[http://eagain.net/articles/git-for-computer-scientists/ Git for Computer Scientists] ''Quick introduction to git internals for people who are not scared by words like Directed Acyclic Graph.''
+*[http://www.youtube.com/watch?v=4XpnKHJAok8 Linus Torvalds on Git] ''Why git? answered by the man that started it.''
+*[http://gitready.com/ Git Ready!] ''Learn git one commit at a time''
+*[http://book.git-scm.com Git Community Book] ''An online book covering git from the basics to some advanced features''
+*[http://www-cs-students.stanford.edu/~blynn/gitmagic Git Magic] ''Covers some concepts and common usage patterns''
+*[http://ktown.kde.org/~zrusin/git/git-cheat-sheet.svg Zack Rusin's git cheat sheet]
+*[http://cheat.errtheblog.com/s/git Git cheat sheet] ''Yet another git cheat sheet''
+*[http://sysmonblog.co.uk/misc/git_by_example git by example] ''git command reference and explanation''
+*[http://jonas.nitro.dk/git/quick-reference.html Git Quick Reference] ''Yet another reference of the most used git commands''
-% of the time this is all that is needed:
+= Todo for this doc  =
- git pull #update to latest code
+*creating feature branches
- #edit code, build, it works!
+*history manipulation. rebase -i, commit --append, and what to do when things go wrong. Probably its own page.
- git status #to check if you want to commit all the modified files
- git commit -a #the -a option commits all modified files. use git add to select them individually
- git push