KernelGitGuide

Differences between revisions 52 and 53
Revision 52 as of 2009-03-17 07:12:56
Size: 8366
Editor: 220
Comment: replace git-xxx command style to git xxx
Revision 53 as of 2009-04-02 18:37:27
Size: 8068
Editor: apw
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
Git is the new SCM used by the Linux kernel developers. Ubuntu has adopted this tool for our own Linux kernel source code so that we can interact better with the community and the other kernel developers. Git is the source code management tool used by the Linux kernel developer community.  Ubuntu has adopted this tool for our own Linux kernel source code so that we can interact better with the community and the other kernel developers.
Line 4: Line 4:
= Where is it? =

http://kernel.ubuntu.com/
Line 10: Line 7:
 * jaunty: git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git
 * intrepid: git://kernel.ubuntu.com/ubuntu/ubuntu-intrepid.git
 * hardy: git://kernel.ubuntu.com/ubuntu/ubuntu-hardy.git
 * gutsy: git://kernel.ubuntu.com/ubuntu/ubuntu-gutsy.git
 * feisty: git://kernel.ubuntu.com/ubuntu/ubuntu-feisty.git
 * edgy: git://kernel.ubuntu.com/ubuntu/ubuntu-edgy.git
 * dapper: git://kernel.ubuntu.com/ubuntu/ubuntu-dapper.git
All of the current live Ubuntu kernel repositories are at the URL below:
Line 18: Line 9:
(actually there are a few more and of special note are the -updates git trees. To find out what else is available try browsing http://kernel.ubuntu.com/git and searching for ubuntu)     {{{
http://kernel.ubuntu.com/git/
}}}
Line 20: Line 13:
= Getting GIT = There is a tree for each of the currently supported releases as well as any open development and upcoming releases:
Line 22: Line 15:
To obtain the git binaries, simply install the `git-core` package from dapper, e.g.:
{{{
  sudo apt-get install git-core
}}}
 || karmic || git://kernel.ubuntu.com/ubuntu/ubuntu-karmic.git ||
 || jaunty || git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git ||
 || intrepid || git://kernel.ubuntu.com/ubuntu/ubuntu-intrepid.git ||
 || hardy || git://kernel.ubuntu.com/ubuntu/ubuntu-hardy.git ||
 || gutsy || git://kernel.ubuntu.com/ubuntu/ubuntu-gutsy.git ||
 || feisty || git://kernel.ubuntu.com/ubuntu/ubuntu-feisty.git ||
 || edgy || git://kernel.ubuntu.com/ubuntu/ubuntu-edgy.git ||
 || dapper || git://kernel.ubuntu.com/ubuntu/ubuntu-dapper.git ||

To find out what else is available try browsing http://kernel.ubuntu.com/git
and searching for ubuntu).

= Installing GIT =

To obtain the git binaries, simply install the `git-core` package:
    {{{
sudo apt-get install git-core}}}
Line 32: Line 38:
The Ubuntu Linux kernel git repository is located at git://kernel.ubuntu.com/ubuntu/ubuntu-<release>.git. To download a local copy of the repo, use this command:
{{{
  git clone git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git ubuntu-jaunty
}}}
Line 37: Line 39:
This will take some time depending on your connection. There's around 220 MiB of data to download currently (and this always increases). If you already have an upstream kernel tree, you can use the --reference option to avoid downloading redundant objects:
{{{
  git clone --reference linux-2.6/ git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git
}}}
The Ubuntu Linux kernel git repository is located at
git://kernel.ubuntu.com/ubuntu/ubuntu-<release>.git. To download a local
copy of the repo, use this command:

    {{{
git clone git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git}}}

This will take some time depending on your connection. There is several
hundred megabytes of data to download. If you already have an upstream
kernel tree, you can use the --reference option to avoid downloading
redundant objects:

    {{{
git clone --reference linux-2.6/ git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git}}}
Line 45: Line 57:
{{{
  cd ubuntu-jaunty
}}}
    {{{
cd ubuntu-jaunty}}}
Line 49: Line 60:
Get a copy of the kernel version you want to work on. To determine which the latest official release is: By default your will have the latest version of the kernel tree, the
master tree. You can g
et a copy of the kernel version you want to work
on. To determine which the latest official release is:
Line 51: Line 64:
{{{
  git tag | grep Ubuntu*
}}}
    {{{
git tag | grep Ubuntu*}}}
Line 57: Line 69:
{{{
  Ubuntu-2.6.27-7.10
  Ubuntu-2.6.27-7.11
  Ubuntu-2.6.27-7.12
  Ubuntu-2.6.27-7.13
  Ubuntu-2.6.27-7.14
}}}
    {{{
Ubuntu-2.6.27-7.10
Ubuntu-2.6.27-7.11
Ubuntu-2.6.27-7.12
Ubuntu-2.6.27-7.13
Ubuntu-2.6.27-7.14}}}
Line 65: Line 76:
For example, with the exact above output, this would be a correct choice: For example, with the exact above output you could checkout the latest
released version of the kernel:
Line 67: Line 79:
{{{
  git checkout Ubuntu-2.6.27-7.14
}}}
    {{{
git checkout Ubuntu-2.6.27-7.14}}}
Line 72: Line 83:
{{{
  git pull
}}}
    {{{
git fetch}}}
Line 77: Line 87:
During development, the kernel git repository is being constantly rebased against Linus' tree. IOW, Ubuntu specific changes are not being ''merged'', but rather popped off, the tree rebased and then pushed on to keep them on top. This will cause git pull to fail. Hence, there are two ways to track the kernel git tree, depending on whether you have local changes or not. During development, the kernel git repository is being constantly rebased
against Linus' tree. IOW, Ubuntu specific changes are not being ''merged'',
but rather popped off, the tree updated to mainline, and then the Ubuntu
specific changes reapplied; they are rebased. There are two ways to trac
k
the kernel git tree, depending on
whether you have local changes or not:
Line 80: Line 94:
{{{
  git fetch -f origin
  git checkout origin
  git branch -f master origin
  git checkout master
    {{{
git fetch
git reset --hard origin/master
Line 88: Line 100:
{{{
  # Save away local commits
  git rev-list --reverse origin..HEAD > local-commits
  git branch new-head origin
  git checkout new-head
  # This will stop on first error. Cleaning up failures is an exercise for the user
  for cmt in `cat local-commits`; do git cherry-pick $cmt || break; done
  git branch -f master new-head
  git checkout master
  git branch -D new-head
}}}

Alternatively, you can accomplish the same thing in the following way.

'''No Local Changes'''
{{{
  git fetch
  git reset --hard origin/master
}}}

'''Preserve Local Changes'''
{{{
  git fetch
  git rebase --onto origin/master origin/master@{1}
    {{{
git fetch
git rebase --onto origin/master origin/master@{1}

Summary

Git is the source code management tool used by the Linux kernel developer community. Ubuntu has adopted this tool for our own Linux kernel source code so that we can interact better with the community and the other kernel developers.

Current GIT Trees

All of the current live Ubuntu kernel repositories are at the URL below:

  • http://kernel.ubuntu.com/git/

There is a tree for each of the currently supported releases as well as any open development and upcoming releases:

  • karmic

    git://kernel.ubuntu.com/ubuntu/ubuntu-karmic.git

    jaunty

    git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git

    intrepid

    git://kernel.ubuntu.com/ubuntu/ubuntu-intrepid.git

    hardy

    git://kernel.ubuntu.com/ubuntu/ubuntu-hardy.git

    gutsy

    git://kernel.ubuntu.com/ubuntu/ubuntu-gutsy.git

    feisty

    git://kernel.ubuntu.com/ubuntu/ubuntu-feisty.git

    edgy

    git://kernel.ubuntu.com/ubuntu/ubuntu-edgy.git

    dapper

    git://kernel.ubuntu.com/ubuntu/ubuntu-dapper.git

To find out what else is available try browsing http://kernel.ubuntu.com/git and searching for ubuntu).

Installing GIT

To obtain the git binaries, simply install the git-core package:

  • sudo apt-get install git-core

Use apt-get because other tools such as aptitude will autoremove packages that have no install links.

Note that the git package is an entirely different tool which will not do what you want.

Getting the Ubuntu Linux kernel repo

The Ubuntu Linux kernel git repository is located at git://kernel.ubuntu.com/ubuntu/ubuntu-<release>.git. To download a local copy of the repo, use this command:

  • git clone git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git

This will take some time depending on your connection. There is several hundred megabytes of data to download. If you already have an upstream kernel tree, you can use the --reference option to avoid downloading redundant objects:

  • git clone --reference linux-2.6/ git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git

This will reduce the amount of data to download to around 6 MiB.

Change into the directory:

  • cd ubuntu-jaunty

By default your will have the latest version of the kernel tree, the master tree. You can get a copy of the kernel version you want to work on. To determine which the latest official release is:

  • git tag | grep Ubuntu*

This results in something like this:

  • Ubuntu-2.6.27-7.10
    Ubuntu-2.6.27-7.11
    Ubuntu-2.6.27-7.12
    Ubuntu-2.6.27-7.13
    Ubuntu-2.6.27-7.14

For example, with the exact above output you could checkout the latest released version of the kernel:

  • git checkout Ubuntu-2.6.27-7.14

Once this is complete, you can keep your tree up-to-date by running this command:

  • git fetch

** Warning ** During development, the kernel git repository is being constantly rebased against Linus' tree. IOW, Ubuntu specific changes are not being merged, but rather popped off, the tree updated to mainline, and then the Ubuntu specific changes reapplied; they are rebased. There are two ways to track the kernel git tree, depending on whether you have local changes or not:

No Local Changes

  • git fetch
    git reset --hard origin/master

Preserve Local Changes

  • git fetch
    git rebase --onto origin/master origin/master@{1}

Pushing changes to the main repo

Since the main repo is not publicly writable, the primary means for sending patches to the kernel team is using git format-patch. The output from this command can then be sent to the kernel-team mailing list.

Alternatively, if you have a publicly available git repository for which changes can be pulled from, you can use git request-pull to generate an email message to send to the kernel-team mailing list.

Commit templates

In debian/commit-templates/ there are several templates that must be used when commiting changes that you expect to be integrated with the Ubuntu kernel repo. The commit templates contain comments for how to fill out the required information. Also note that all commits must have a Signed-off-by line (the "-s" option to git commit). A typical git commit command will look like:

  git commit -s -F debian/commit-templates/patch -e

Note that the -e (edit) option must follow the -F option, else git will not let you edit the commit-template before committing.

An example commit log will look like such:

  UBUNTU: scsi: My cool change to the scsi subsystem

  UpstreamStatus: Merged with 2.6.15-rc3

  My cool change to the scsi subsystem makes scsi transfers increase
  magically to 124GiB/sec.

  Signed-off-by: Joe Cool Hacker <jch@ubuntu.com>

Patch acceptance criteria

In general, Ubuntu will apply the same criteria applicable to upstream kernel. Here is a checklist of reading and tools related to posting kernel patches:

  • <kernel-directory>/Documentation/SubmittingPatches

  • <kernel-directory>/scripts/checkpatch.pl

  • <kernel-directory>/scripts/cleanpatch

  • <kernel-directory>/scripts/cleanfile

  • <kernel-directory>/scripts/Lindent

If you are creating a new file, it is helpful to run it through cleanfile and/or Linent before creating a patch
If you have generated a patch, it helps running it through checkpatch.pl and cleanpatch if necessary
Also, using the commit template described above is a good idea for Ubuntu-specific patches

Developers with access to kernel.ubuntu.com

The kernel team has a git repo located on kernel.ubuntu.com (AKA zinc.ubuntu.com) in /srv/kernel.ubuntu.com/git/ubuntu.

You can, if you want, create a clone for yourself in your directory, and just have your changes pulled when ready.

Suggested way to do this:

git clone -l -n -s /srv/kernel.ubuntu.com/git/ubuntu/ubuntu-jaunty.git
vi ubuntu-jaunty/.git/description
( give it a descriptive name )
mv ubuntu-jaunty/.git /srv/kernel.ubuntu.com/git/<user>/my-git-tree.git

You can now push your changes to this tree via ssh. Note the -l -n -s options do a few special things, mainly making your repo share objects with ours (saves space).

Now you need to run git update-server-info in your tree so that it is available over http transport

cd /srv/kernel.ubuntu.com/git/<user>/my-git-tree.git
git update-server-info
chmod +x /srv/kernel.ubuntu.com/git/<user>/my-git-tree.git/hooks/post-commit

To work on your branch, now clone to your local machine from the same origin tree (not the tree you just created on zinc -- this is only for pushing to):

git clone git://kernel.ubuntu.com/ubuntu/ubuntu-jaunty.git my-tree
*do work*
git send-pack kernel.ubuntu.com:/srv/kernel.ubuntu.com/git/<user>/my-git-tree.git master

Suggested method for keeping this tree synced with the ubuntu tree, instead of git pull, is to do:

cd my-tree
git fetch origin
git rebase origin

This will keep your changes on top of the original tree (as opposed to being merged). This is also a good idea because during development (e.g. while following the upstream git repo), we frequently rebase to linux-2.6.git upstream, so the HEAD is not always suitable for pull/merge.

Git tips and tricks

Reordering patches

git rebase -i HEAD~10

allows you to interactively reorder the last 10 patches in your branch. You can also squash some patches together. Just follow the directions at the bottom of the file opened up on typing the command.

More information

Please read the documentation included with the git-core package for more details on git commands. A tutorial is also available at http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html.


CategoryKernel CategoryDocumentation

KernelTeam/KernelGitGuide (last edited 2010-06-28 23:55:41 by c-76-105-148-120)