xref: /dragonfly/share/man/man7/development.7 (revision 99dd49c5) 
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 March 26, 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
42uses the
43.Xr git 1
44distributed revision control system.
45If 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
49The
50.Sx EXAMPLES
51section gives initial information to get going with development on
52.Dx .
53Please refer to the
54.Xr git 1
55manual pages and other related documents for further information on git's
56capabilities and how to use them.
57.Pp
58For information on how to build the
59.Dx
60system from source code, see
61.Xr build 7 .
62For information on how to build the LiveCD, LiveDVD or thumb drive image, see
63.Xr release 7 .
64.Sh EXAMPLES
65A fresh copy of the repository can be cloned anywhere.
66Note that the directory to clone into
67.Pa ( /usr/src
68in the following example) must not exist, so all previous work in this
69directory has to be saved and the directory be removed prior to cloning.
70Also note that while the main repository is on
71.Pa crater ,
72it is recommended that one of the
73.Dx
74mirrors be used instead.
75.Pp
76Simple setup and updating of local repository is done using
77.Pa /usr/Makefile :
78.Bd -literal -offset 4n
79cd /usr
80make help	# get help
81make git-clone	# initial setup
82make git-update
83.Ed
84.Pp
85Somewhat finer control can be achieved using
86.Xr git 1
87directly.
88To clone the repository and check out the master branch (this will take
89some time):
90.Bd -literal -offset 4n
91cd /usr
92git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
93cd src
94.Ed
95.Pp
96The repository can be held up to date by pulling frequently (to set up a
97.Xr cron 8
98job,
99.Xr git 1 Ap s
100.Fl Fl git-dir
101option can be used):
102.Bd -literal -offset 4n
103cd /usr/src
104git pull
105.Ed
106.Pp
107It is not recommended to work directly in the master branch.
108To create and checkout a working branch:
109.Bd -literal -offset 4n
110git checkout -b work
111.Ed
112.Pp
113To create and checkout a branch of the
114.Dx 2.0
115release (called
116.Sy rel2_0 ) :
117.Bd -literal -offset 4n
118git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
119.Ed
120.Pp
121Branches can be deleted just as easy:
122.Bd -literal -offset 4n
123git branch -d work
124.Ed
125.Pp
126After changes have been made to a branch, they can be committed:
127.Bd -literal -offset 4n
128git commit -a
129.Ed
130.Pp
131.Xr git-commit 1 Ap s
132.Fl m
133and
134.Fl F
135options can be used to specify a commit message on the command line or read
136it from a file, respectively.
137.Pp
138Finally, branches can be merged with the (updated) master by using
139.Cm rebase :
140.Bd -literal -offset 4n
141git checkout master
142git pull
143git checkout work
144git rebase master
145.Ed
146.Sh SEE ALSO
147.Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
148.Xr build 7 ,
149.Xr committer 7 ,
150.Xr release 7
151.Sh HISTORY
152The
153.Nm
154manual page was originally written by
155.An Matthew Dillon Aq dillon@FreeBSD.org
156and first appeared
157in
158.Fx 5.0 ,
159December 2002.
160It was rewritten when
161.Dx
162switched to
163.Xr git 1 .
164