3 .\" The DragonFly Project. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\" contributors may be used to endorse or promote products derived
17 .\" from this software without specific, prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $DragonFly: src/share/man/man7/development.7,v 1.12 2008/07/27 22:23:42 thomas Exp $
39 .Nd quick starter for development with the DragonFly codebase
44 distributed revision control system.
45 If it is not already on the system, it needs to be installed via
47 .Pa ( /usr/pkgsrc/devel/scmgit ) .
51 section gives initial information to get going with development on
55 manual pages and other related documents for further information on git's
56 capabilities and how to use them.
59 section below has some links.
61 For information on how to build the
63 system from source code, see
65 For information on how to build the LiveCD, LiveDVD or thumb drive image, see
68 A fresh copy of the repository can be cloned anywhere.
69 Note that the directory to clone into
71 in the following example) must not exist, so all previous work in this
72 directory has to be saved and the directory be removed prior to cloning.
73 Also note that while the main repository is on
75 it is recommended that one of the
77 mirrors be used instead.
79 Simple setup and updating of local repository is done using
81 .Bd -literal -offset 4n
84 make git-clone # initial setup
88 Somewhat finer control can be achieved using
91 To clone the repository and check out the master branch (this will take
93 .Bd -literal -offset 4n
95 git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
99 The repository can be held up to date by pulling frequently (to set up a
105 .Bd -literal -offset 4n
110 It is not recommended to work directly in the master branch.
111 To create and checkout a working branch:
112 .Bd -literal -offset 4n
116 To create and checkout a branch of the
120 .Bd -literal -offset 4n
121 git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
124 Branches can be deleted just as easy:
125 .Bd -literal -offset 4n
129 After changes have been made to a branch, they can be committed:
130 .Bd -literal -offset 4n
134 .Xr git-commit 1 Ap s
138 options can be used to specify a commit message on the command line or read
139 it from a file, respectively.
141 Finally, branches can be merged with the (updated) master by using
143 .Bd -literal -offset 4n
150 When importing vendor sources, make sure that you don't import
151 too many unnecessary sources.
152 Especially test suites that are not used by the
154 build are good candidates for being stripped away.
155 These instructions assume that you have already extracted
156 the source package into its final directory and that they are
157 trimmed appropriately.
159 .Em \&Do not change the vendor sources before importing them
160 on the vendor branch!
161 Necessary changes to the vendor sources can be applied to
165 For the following commands, we will import the imaginary package
168 .Pa /usr/src/contrib/foo .
169 If this is the first import of
171 you will have to choose the name of the vendor branch.
172 Customarily, this will be
174 However, if you intend to maintain multiple vendor sources for the
177 you should choose a branch name which includes part of the version,
181 As a first step, we trick git to work on the vendor branch instead of on
183 Be careful, since after issuing this command all your commits will go to the
184 vendor branch, but you will commit
185 .Em the whole working tree
186 and not just the vendor sources!
187 Thus you have to specify the exact directory for
189 In order to commit, you will have to add the new sources first.
190 .Bd -literal -offset 4n
191 git symbolic-ref HEAD refs/heads/vendor/FOO
193 git commit -m "Import foo-2.3" contrib/foo
196 With these commands we have imported the vendor sources on their own branch.
197 In the next step, we merge the vendor branch into master.
198 .Bd -literal -offset 4n
203 Now you are free to change the sources in contrib/foo, since you are
207 The first thing to do is to add
211 The former documents how the imported sources can be obtained, including
212 a checksum of the tarball.
213 The latter lists all files and directories that have been removed from the
216 .Pa /usr/src/tools/tools/genreadmedeleted/genreadmedeleted
217 shell script to generate this file.
220 first, then commit your local changes to the sources:
221 .Bd -literal -offset 4n
222 git add contrib/foo/README.D*
223 git commit -m "foo: add our READMEs"
226 Finally, push master and the vendor branch to crater:
227 .Bd -literal -offset 4n
228 git push crater master vendor/FOO
231 .Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
236 .%T "Git User's Manual"
237 .%O "http://www.kernel.org/pub/software/scm/git/docs/user-manual.html"
241 .%O "http://www-cs-students.stanford.edu/~blynn/gitmagic/"
246 manual page was originally written by
247 .An Matthew Dillon Aq dillon@FreeBSD.org
252 It was rewritten when