KernelGitGuide
1331
Comment: New page describing our kernel git repo
|
4290
|
Deletions are marked like this. | Additions are marked like this. |
Line 4: | Line 4: |
= Where is it? = http://kernel.ubuntu.com/ = Current GIT Trees = * 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 (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) |
|
Line 5: | Line 18: |
To obtain the git binaries, please go to [http://www.kernel.org/pub/software/scm/git-core kernel.org] and download the latest source. Folow the build instructions included, and make sure to install them in a location in your PATH. | To obtain the git binaries, simply install the `git-core` package from dapper, e.g.: {{{ sudo apt-get install git-core }}} '''Note that the `git` package is an entirely different tool which will not do what you want.''' |
Line 8: | Line 27: |
The Ubuntu Linux kernel git repository is located at rsync://rsync.kernel.org/pub/scm/linux/kernel/git/bcollins/ubuntu-2.6.git. To download a local copy of the repo, use this command: | 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: |
Line 10: | Line 29: |
git clone rsync://rsync.kernel.org/pub/scm/linux/kernel/git/bcollins/ubuntu-2.6.git ubuntu-2.6 | git clone git://kernel.ubuntu.com/ubuntu/ubuntu-gutsy.git ubuntu-gutsy |
Line 13: | Line 32: |
This will take some time depending on your connection. There's around 110Megs of data to download currently (and this always increases). | This will take some time depending on your connection. There's around 220 MiB of data to download currently (and this always increases). |
Line 20: | Line 39: |
= 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 [mailto:kernel-team@lists.ubuntu.com 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 [mailto:kernel-team@lists.ubuntu.com 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@reet.com> }}} = 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-gutsy.git vi ubuntu-gutsy/.git/description ( give it a descriptive name ) mv ubuntu-gutsy/.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). Suggest 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. |
|
Line 21: | Line 90: |
Please read the documentation included with the git source for more details on using git. | Please read the documentation included with the '''git-core''' package for more details on git commands. |
Line 23: | Line 92: |
If you are an Ubuntu kernel developer with access to people.ubuntu.com, you can follow the KernelDeveloperGuide to get more information. |
Summary
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.
Where is it?
Current GIT Trees
- 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
(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)
Getting GIT
To obtain the git binaries, simply install the git-core package from dapper, e.g.:
sudo apt-get install git-core
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-gutsy.git ubuntu-gutsy
This will take some time depending on your connection. There's around 220 MiB of data to download currently (and this always increases).
Once this is complete, you can keep your tree up-to-date by running this command:
git pull
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 [mailto:kernel-team@lists.ubuntu.com 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 [mailto:kernel-team@lists.ubuntu.com 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@reet.com>
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-gutsy.git vi ubuntu-gutsy/.git/description ( give it a descriptive name ) mv ubuntu-gutsy/.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).
Suggest 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.
More information
Please read the documentation included with the git-core package for more details on git commands.
KernelTeam/KernelGitGuide (last edited 2010-06-28 23:55:41 by c-76-105-148-120)