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
37 .Nd quick starter for development with the DragonFly codebase
42 distributed revision control system.
43 If it is not already on the system, it needs to be installed via
49 section gives initial information to get going with development on
53 manual pages and other related documents for further information on git's
54 capabilities and how to use them.
57 section below has some links.
59 For information on how to build the
61 system from source code, see
63 For information on how to build the LiveCD, LiveDVD or thumb drive image, see
66 For a specification of
68 preferred source code style, refer to
72 function to switch C-mode to this style (more or less) can be found in
73 .Pa /usr/share/misc/dragonfly.el .
77 .Pa /usr/share/misc/dragonfly.vim
80 A fresh copy of the repository can be cloned anywhere.
81 Note that the directory to clone into
83 in the following example) must not exist, so all previous work in this
84 directory has to be saved and the directory be removed prior to cloning.
85 Also note that while the main repository is on
87 it is recommended that one of the
89 mirrors be used instead.
91 Simple setup and updating of local repository is done using
93 .Bd -literal -offset 4n
96 make src-checkout # initial setup
100 Somewhat finer control can be achieved using
103 To clone the repository and check out the master branch (this will take
105 .Bd -literal -offset 4n
107 git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
111 The repository can be held up to date by pulling frequently (to set up a
117 .Bd -literal -offset 4n
122 It is not recommended to work directly in the master branch.
123 To create and checkout a working branch:
124 .Bd -literal -offset 4n
128 To create and checkout a branch of the
132 .Bd -literal -offset 4n
133 git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
136 Branches can be deleted just as easy:
137 .Bd -literal -offset 4n
141 After changes have been made to a branch, they can be committed:
142 .Bd -literal -offset 4n
146 .Xr git-commit 1 Ap s
150 options can be used to specify a commit message on the command line or read
151 it from a file, respectively.
153 Finally, branches can be merged with the (updated) master by using
155 .Bd -literal -offset 4n
162 When importing vendor sources, make sure that you don't import
163 too many unnecessary sources.
164 Especially test suites that are not used by the
166 build are good candidates for being stripped away.
167 These instructions assume that you have already extracted
168 the source package into its final directory and that they are
169 trimmed appropriately.
171 .Em \&Do not change the vendor sources before importing them
172 on the vendor branch!
173 Necessary changes to the vendor sources can be applied to
177 For the following commands, we will import the imaginary package
180 .Pa /usr/src/contrib/foo .
181 If this is the first import of
183 you will have to choose the name of the vendor branch.
184 Customarily, this will be
186 However, if you intend to maintain multiple vendor sources for the
189 you should choose a branch name which includes part of the version,
193 As a first step, we trick git to work on the vendor branch instead of on
195 Be careful, since after issuing this command all your commits will go to the
196 vendor branch, but you will commit
197 .Em the whole working tree
198 and not just the vendor sources!
199 Thus you have to specify the exact directory for
201 In order to commit, you will have to add the new sources first.
203 If the vendor branch already exists, make sure that you have a local vendor
204 branch which is up to date.
206 .Bd -literal -offset 4n
207 git update-ref refs/heads/vendor/FOO origin/vendor/FOO
210 The next commands perform the actual import.
211 .Bd -literal -offset 4n
212 git symbolic-ref HEAD refs/heads/vendor/FOO
214 git commit -m "Import foo-2.3" contrib/foo
217 With these commands we have imported the vendor sources on their own branch.
218 In the next step, we merge the vendor branch into master.
219 .Bd -literal -offset 4n
224 Now you are free to change the sources in contrib/foo, since you are
228 The first thing to do is to add
232 The former documents how the imported sources can be obtained, including
233 a checksum of the tarball.
234 The latter lists all files and directories that have been removed from the
237 .Pa /usr/src/tools/tools/genreadmedeleted/genreadmedeleted
238 shell script to generate this file.
241 first, then commit your local changes to the sources:
242 .Bd -literal -offset 4n
243 git add contrib/foo/README.D*
244 git commit -m "foo: add our READMEs"
247 Finally, push master and the vendor branch to crater:
248 .Bd -literal -offset 4n
249 git push crater master vendor/FOO
252 .Xr git 1 Pq Pa devel/git ,
257 .%T "Documentation on git's page"
258 .%O "http://git-scm.com/documentation"
262 .%O "http://www-cs-students.stanford.edu/~blynn/gitmagic/"
267 manual page was originally written by
268 .An Matthew Dillon Aq Mt dillon@FreeBSD.org
273 It was rewritten when