xref: /dragonfly/share/man/man7/development.7 (revision 3cb6a21a) 
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 February 11, 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 a LiveCD, 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.
70.Pp
71Simple setup and updating of local repository is done using
72.Pa /usr/Makefile :
73.Pp
74.Bd -literal -offset 4n
75cd /usr
76make help	# get help
77make git-clone	# initial setup
78make git-update
79.Ed
80.Pp
81Somewhat finer control can be achieved using
82.Xr git 1
83directly:
84To clone the repository and check out the master branch (this will take
85some time):
86.Bd -literal -offset 4n
87cd /usr
88git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
89cd src
90.Ed
91.Pp
92The repository can be held up to date by pulling frequently (to set up a
93.Xr cron 8
94job,
95.Xr git 1 Ap s
96.Fl Fl git-dir
97option can be used):
98.Bd -literal -offset 4n
99cd /usr/src
100git pull
101.Ed
102.Pp
103It is not recommended to work directly in the master branch.
104To create and checkout a working branch:
105.Bd -literal -offset 4n
106git checkout -b work
107.Ed
108.Pp
109To create and checkout a branch of the
110.Dx 2.0
111release (called
112.Sy rel2_0 ) :
113.Bd -literal -offset 4n
114git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
115.Ed
116.Pp
117Branches can be deleted just as easy:
118.Bd -literal -offset 4n
119git branch -d work
120.Ed
121.Pp
122After changes have been made to a branch, they can be committed:
123.Bd -literal -offset 4n
124git commit -a
125.Ed
126.Pp
127.Xr git-commit 1 Ap s
128.Fl m
129and
130.Fl F
131options can be used to specify a commit message on the command line or read
132it from a file, respectively.
133.Pp
134Finally, branches can be merged with the (updated) master by using
135.Cm rebase :
136.Bd -literal -offset 4n
137git checkout master
138git pull
139git checkout work
140git rebase master
141.Ed
142.Sh SEE ALSO
143.Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
144.Xr build 7 ,
145.Xr committer 7 ,
146.Xr release 7
147.Sh HISTORY
148The
149.Nm
150manual page was originally written by
151.An Matthew Dillon Aq dillon@FreeBSD.org
152and first appeared
153in
154.Fx 5.0 ,
155December 2002.
156It was rewritten when
157.Dx
158switched to
159.Xr git 1 .
160