debian: add Breaks relation to help dgit upgrades
[git/debian.git] / debian / README.source
blobce13c78028f1bcb36089fc3c7556282027849581
1 Git sources for Debian
2 ----------------------
4 The git Debian package sources are available through git, and
5 through 'apt-get source git'.  Getting the sources through git
6 should be preferred:
8  # apt-get install git  # if not yet done
10  $ git clone https://repo.or.cz/r/git/debian.git/ git
11  $ cd git
13 After cloning the repository, you have checked out the debian-sid
14 branch, ready to be used by dpkg-buildpackage, e.g.
16  $ dpkg-buildpackage -i -rfakeroot -uc -us
18 If you want to make changes in the ./debian/ subdirectory, this is the
19 correct branch to work on.  After making changes, document them in
20 debian/changelog, and commit through 'git add' and 'git commit', or 'git
21 commit -a', or similar.  If you think the changes should be incorporated
22 into the standard Debian package, create the patch[es] through 'git
23 format-patch', and send them to the Debian Bug Tracking System, e.g.
25  $ vi debian/rules
26  $ debchange -pi
27  $ git commit -a
28  $ git format-patch HEAD^
31 If you want to make changes to the upstream git sources, first checkout
32 the release+patches branch
34  $ git checkout -b release+patches origin/release+patches
36 The release+patches branch holds patches on top of the current release
37 version that is packaged for Debian/unstable. The current release
38 version is available in the release branch.  If you are interested, you
39 can checkout this branch too
41  $ git checkout -b release origin/release
43 When releasing a new Debian package based on a new upstream release, the
44 release branch will be fastforwarded, and the release+patches branch is
45 rewound and rebased on the new HEAD of the release branch.  This is done
48  $ git checkout release
49  $ git merge v1.6.5
50  $ git checkout release+patches
51  $ git rebase release
53 You generally don't need to do that, but beware that the release+patches
54 branch is rewound occasionally.
56 After checking out the release+patches branch, make the desired changes
57 to the upstream sources, and commit them.  To integrate the changes into
58 the Debian package, extract these changes, and change to the debian-sid
59 branch (Note: the file extension for the patches is '.diff', use 'git
60 config --add format.suffix .diff' to make that the default)
62  $ git format-patch release..release+patches
63  $ git checkout debian-sid
65 Now move the extracted patches into the debian/patches/ directory, add
66 their filenames to debian/patches/series, add a meaningful message to
67 debian/changelog, and commit the changes to the debian-sid branch:
69  $ ls ????-*.diff >> debian/patches/series
70  $ mv ????-*.diff debian/patches/
71  $ git add debian/patches
72  $ debchange -pi
73  $ git add debian/changelog
74  $ git commit
76 Again, if you think the changes should be incorporated into the standard
77 Debian package, create the patch[es] from the debian-sid branch through
78 'git format-patch', send them to the Debian Bug Tracking System.
80 There's a mailing list to coordinate work on the git-core packages, if
81 you're interested in helping please subscribe to the
82 <debian-package-git> mailing list by sending an email to
83 <debian-package-git-subscribe@list.smarden.org>.
85  -- Gerrit Pape <pape@smarden.org>  Sat, 10 Apr 2010 12:28:52 +0000