Update development(7) for git usage.
[dragonfly.git] / share / man / man7 / development.7
CommitLineData
984263bc 1.\"
a63d9f6f
SW
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.\"
71bdc883 32.\" $DragonFly: src/share/man/man7/development.7,v 1.12 2008/07/27 22:23:42 thomas Exp $
984263bc 33.\"
a63d9f6f 34.Dd December 1, 2008
984263bc
MD
35.Dt DEVELOPMENT 7
36.Os
37.Sh NAME
38.Nm development
a63d9f6f 39.Nd quick starter for development with the DragonFly codebase
984263bc 40.Sh DESCRIPTION
8c1a5cc4 41.Dx
a63d9f6f
SW
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 ) .
984263bc 48.Pp
a63d9f6f
SW
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
8c1a5cc4 59.Dx
a63d9f6f
SW
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
71To clone the repository and check out the master branch (this will take
72some time):
984263bc
MD
73.Bd -literal -offset 4n
74cd /usr
a63d9f6f
SW
75git clone -o crater git://crater.dragonflybsd.org/dragonfly.git src
76cd src
984263bc
MD
77.Ed
78.Pp
a63d9f6f
SW
79The repository can be held up to date by pulling frequently (to set up a
80.Xr cron 8
81job,
82.Xr git 1 Ap s
83.Fl Fl git-dir
84option can be used):
984263bc
MD
85.Bd -literal -offset 4n
86cd /usr/src
a63d9f6f 87git pull
984263bc
MD
88.Ed
89.Pp
a63d9f6f
SW
90It is not recommended to work directly in the master branch.
91To create and checkout a working branch:
984263bc 92.Bd -literal -offset 4n
a63d9f6f 93git checkout -b work
984263bc
MD
94.Ed
95.Pp
a63d9f6f
SW
96To create and checkout a branch of the
97.Dx 2.0
98release (called
99.Sy rel2_0 ) :
984263bc 100.Bd -literal -offset 4n
a63d9f6f 101git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
984263bc 102.Ed
984263bc 103.Pp
a63d9f6f 104Branches can be deleted just as easy:
984263bc 105.Bd -literal -offset 4n
a63d9f6f 106git branch -d work
984263bc
MD
107.Ed
108.Pp
a63d9f6f 109After changes have been made to a branch, they can be committed:
95b3720c 110.Bd -literal -offset 4n
a63d9f6f 111git commit -a
95b3720c
HP
112.Ed
113.Pp
a63d9f6f
SW
114.Xr git-commit 1 Ap s
115.Fl m
116and
117.Fl F
118options can be used to specify a commit message on the command line or read
119it from a file, respectively.
95b3720c 120.Pp
a63d9f6f
SW
121Finally, branches can be merged with the (updated) master by using
122.Cm rebase :
984263bc 123.Bd -literal -offset 4n
a63d9f6f
SW
124git checkout master
125git pull
126git checkout work
127git rebase master
984263bc 128.Ed
984263bc 129.Sh SEE ALSO
a63d9f6f 130.Xr git 1 Pq Pa pkgsrc/devel/scmgit ,
984263bc 131.Xr build 7 ,
71bdc883 132.Xr committer 7 ,
a63d9f6f 133.Xr release 7
984263bc
MD
134.Sh HISTORY
135The
136.Nm
137manual page was originally written by
138.An Matthew Dillon Aq dillon@FreeBSD.org
139and first appeared
140in
141.Fx 5.0 ,
142December 2002.
a63d9f6f
SW
143It was rewritten when
144.Dx
145switched to
146.Xr git 1 .