ed0038ccfa87cd6f1147087f8a82036794c5bb09
[dragonfly.git] / share / man / man7 / development.7
1 .\"
2 .\" Copyright (c) 2008
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
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
14 .\"    distribution.
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.
18 .\"
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
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $DragonFly: src/share/man/man7/development.7,v 1.12 2008/07/27 22:23:42 thomas Exp $
33 .\"
34 .Dd September 30, 2009
35 .Dt DEVELOPMENT 7
36 .Os
37 .Sh NAME
38 .Nm development
39 .Nd quick starter for development with the DragonFly codebase
40 .Sh DESCRIPTION
41 .Dx
42 uses the
43 .Xr git 1
44 distributed revision control system.
45 If it is not already on the system, it needs to be installed via
46 .Xr pkgsrc 7
47 .Pa ( /usr/pkgsrc/devel/scmgit ) .
48 .Pp
49 The
50 .Sx EXAMPLES
51 section gives initial information to get going with development on
52 .Dx .
53 Please refer to the
54 .Xr git 1
55 manual pages and other related documents for further information on git's
56 capabilities and how to use them.
57 The
58 .Sx SEE ALSO
59 section below has some links.
60 .Pp
61 For information on how to build the
62 .Dx
63 system from source code, see
64 .Xr build 7 .
65 For information on how to build the LiveCD, LiveDVD or thumb drive image, see
66 .Xr release 7 .
67 .Sh EXAMPLES
68 A fresh copy of the repository can be cloned anywhere.
69 Note that the directory to clone into
70 .Pa ( /usr/src
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
74 .Pa crater ,
75 it is recommended that one of the
76 .Dx
77 mirrors be used instead.
78 .Pp
79 Simple setup and updating of local repository is done using
80 .Pa /usr/Makefile :
81 .Bd -literal -offset 4n
82 cd /usr
83 make help       # get help
84 make git-clone  # initial setup
85 make git-update
86 .Ed
87 .Pp
88 Somewhat finer control can be achieved using
89 .Xr git 1
90 directly.
91 To clone the repository and check out the master branch (this will take
92 some time):
93 .Bd -literal -offset 4n
94 cd /usr
95 git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
96 cd src
97 .Ed
98 .Pp
99 The repository can be held up to date by pulling frequently (to set up a
100 .Xr cron 8
101 job,
102 .Xr git 1 Ap s
103 .Fl Fl git-dir
104 option can be used):
105 .Bd -literal -offset 4n
106 cd /usr/src
107 git pull
108 .Ed
109 .Pp
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
113 git checkout -b work
114 .Ed
115 .Pp
116 To create and checkout a branch of the
117 .Dx 2.0
118 release (called
119 .Sy rel2_0 ) :
120 .Bd -literal -offset 4n
121 git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
122 .Ed
123 .Pp
124 Branches can be deleted just as easy:
125 .Bd -literal -offset 4n
126 git branch -d work
127 .Ed
128 .Pp
129 After changes have been made to a branch, they can be committed:
130 .Bd -literal -offset 4n
131 git commit -a
132 .Ed
133 .Pp
134 .Xr git-commit 1 Ap s
135 .Fl m
136 and
137 .Fl F
138 options can be used to specify a commit message on the command line or read
139 it from a file, respectively.
140 .Pp
141 Finally, branches can be merged with the (updated) master by using
142 .Cm rebase :
143 .Bd -literal -offset 4n
144 git checkout master
145 git pull
146 git checkout work
147 git rebase master
148 .Ed
149 .Sh VENDOR IMPORTS
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
153 .Dx
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.
158 .Pp
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
162 .Pa master
163 after the import.
164 .Pp
165 For the following commands, we will import the imaginary package
166 .Nm foo-2.3
167 into
168 .Pa /usr/src/contrib/foo .
169 If this is the first import of
170 .Nm foo ,
171 you will have to choose the name of the vendor branch.
172 Customarily, this will be
173 .Pa vendor/FOO .
174 However, if you intend to maintain multiple vendor sources for the
175 same package
176 .Em concurrently ,
177 you should choose a branch name which includes part of the version,
178 i.e.\&
179 .Pa vendor/FOO2 .
180 .Pp
181 As a first step, we trick git to work on the vendor branch instead of on
182 .Pa master .
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
188 .Li git commit .
189 In order to commit, you will have to add the new sources first.
190 .Pp
191 If the vendor branch already exists, make sure that you have a local vendor
192 branch which is up to date.
193 To this end, run:
194 .Bd -literal -offset 4n
195 git update-ref refs/heads/vendor/FOO origin/vendor/FOO
196 .Ed
197 .Pp
198 The next commands perform the actual import.
199 .Bd -literal -offset 4n
200 git symbolic-ref HEAD refs/heads/vendor/FOO
201 git add contrib/foo
202 git commit -m "Import foo-2.3" contrib/foo
203 .Ed
204 .Pp
205 With these commands we have imported the vendor sources on their own branch.
206 In the next step, we merge the vendor branch into master.
207 .Bd -literal -offset 4n
208 git checkout master
209 git merge vendor/FOO
210 .Ed
211 .Pp
212 Now you are free to change the sources in contrib/foo, since you are
213 back on the
214 .Pa master
215 branch.
216 The first thing to do is to add
217 .Pa README.DRAGONFLY
218 and
219 .Pa README.DELETED .
220 The former documents how the imported sources can be obtained, including
221 a checksum of the tarball.
222 The latter lists all files and directories that have been removed from the
223 source package.
224 You should use the
225 .Pa /usr/src/tools/tools/genreadmedeleted/genreadmedeleted
226 shell script to generate this file.
227 Commit the
228 .Pa README Ns s
229 first, then commit your local changes to the sources:
230 .Bd -literal -offset 4n
231 git add contrib/foo/README.D*
232 git commit -m "foo: add our READMEs"
233 .Ed
234 .Pp
235 Finally, push master and the vendor branch to crater:
236 .Bd -literal -offset 4n
237 git push crater master vendor/FOO
238 .Ed
239 .Sh SEE ALSO
240 .Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
241 .Xr build 7 ,
242 .Xr committer 7 ,
243 .Xr release 7
244 .Rs
245 .%T "Git User's Manual"
246 .%O "http://www.kernel.org/pub/software/scm/git/docs/user-manual.html"
247 .Re
248 .Rs
249 .%T "Git Magic"
250 .%O "http://www-cs-students.stanford.edu/~blynn/gitmagic/"
251 .Re
252 .Sh HISTORY
253 The
254 .Nm
255 manual page was originally written by
256 .An Matthew Dillon Aq dillon@FreeBSD.org
257 and first appeared
258 in
259 .Fx 5.0 ,
260 December 2002.
261 It was rewritten when
262 .Dx
263 switched to
264 .Xr git 1 .