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