Update development(7) for git usage.
[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 December 1, 2008
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 .Pp
58 For information on how to build the
59 .Dx
60 system from source code, see
61 .Xr build 7 .
62 For information on how to build a LiveCD, see
63 .Xr release 7 .
64 .Sh EXAMPLES
65 A fresh copy of the repository can be cloned anywhere.
66 Note that the directory to clone into
67 .Pa ( /usr/src
68 in the following example) must not exist, so all previous work in this
69 directory has to be saved and the directory be removed prior to cloning.
70 .Pp
71 To clone the repository and check out the master branch (this will take
72 some time):
73 .Bd -literal -offset 4n
74 cd /usr
75 git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
76 cd src
77 .Ed
78 .Pp
79 The repository can be held up to date by pulling frequently (to set up a
80 .Xr cron 8
81 job,
82 .Xr git 1 Ap s
83 .Fl Fl git-dir
84 option can be used):
85 .Bd -literal -offset 4n
86 cd /usr/src
87 git pull
88 .Ed
89 .Pp
90 It is not recommended to work directly in the master branch.
91 To create and checkout a working branch:
92 .Bd -literal -offset 4n
93 git checkout -b work
94 .Ed
95 .Pp
96 To create and checkout a branch of the
97 .Dx 2.0
98 release (called
99 .Sy rel2_0 ) :
100 .Bd -literal -offset 4n
101 git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
102 .Ed
103 .Pp
104 Branches can be deleted just as easy:
105 .Bd -literal -offset 4n
106 git branch -d work
107 .Ed
108 .Pp
109 After changes have been made to a branch, they can be committed:
110 .Bd -literal -offset 4n
111 git commit -a
112 .Ed
113 .Pp
114 .Xr git-commit 1 Ap s
115 .Fl m
116 and
117 .Fl F
118 options can be used to specify a commit message on the command line or read
119 it from a file, respectively.
120 .Pp
121 Finally, branches can be merged with the (updated) master by using
122 .Cm rebase :
123 .Bd -literal -offset 4n
124 git checkout master
125 git pull
126 git checkout work
127 git rebase master
128 .Ed
129 .Sh SEE ALSO
130 .Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
131 .Xr build 7 ,
132 .Xr committer 7 ,
133 .Xr release 7
134 .Sh HISTORY
135 The
136 .Nm
137 manual page was originally written by
138 .An Matthew Dillon Aq dillon@FreeBSD.org
139 and first appeared
140 in
141 .Fx 5.0 ,
142 December 2002.
143 It was rewritten when
144 .Dx
145 switched to
146 .Xr git 1 .