share/man/man7/committer.7

   1 .\" Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" $DragonFly: src/share/man/man7/committer.7,v 1.8 2007/12/13 20:51:36 swildner Exp $
  34 .\"
  35 .Dd January 1, 2007
  36 .Dt COMMITTER 7
  37 .Os
  38 .Sh NAME
  39 .Nm committer
  40 .Nd rules for DragonFly committers
  41 .Sh CVS REPOSITORY ON YOUR LOCAL MACHINE
  42 Use
  43 .Xr cvsup 1
  44 to mirror the
  45 .Dx
  46 CVS repository itself onto your local box
  47 (if you haven't already).  See the file
  48 .Pa /usr/share/examples/cvsup/DragonFly-cvs-supfile .
  49 .Pp
  50 You basically want to do all CVS operations not related to commits
  51 via your local repository, and do commit operations directly to
  52 the master site.
  53 .Pp
  54 We strongly recommend that you set up a
  55 .Xr cron 8
  56 job to automatically
  57 cvsup at least once a day, so your local CVS repository is always
  58 in sync.
  59 .Sh CHECKING OUT THE SOURCES
  60 Your
  61 .Pa ~/.cvsrc
  62 should contain:
  63 .Bd -literal -offset indent
  64 cvs -q
  65 diff -u
  66 update -Pd
  67 checkout -P
  68 .Ed
  69 .Pp
  70 Checking out and updating a checked out source tree:
  71 .Bd -literal -offset indent
  72 cd /usr
  73 cvs -d /home/dcvs checkout src
  74 cvs -d /home/dcvs update src
  75 .Ed
  76 .Pp
  77 We do
  78 .Em NOT
  79 recommend that you use a cron job to
  80 .Nm cvs Cm update
  81 your
  82 checked out source.  Automatic updates can interfere with
  83 any work-in-progress that you have.
  84 .Sh SSH DSA KEYS:
  85 The CVS repository machine is
  86 .Pa crater.dragonflybsd.org ,
  87 and the
  88 .Dx
  89 developer machine is
  90 .Pa leaf.dragonflybsd.org .
  91 We create
  92 an account for you on both machines and install your public SSH
  93 key to give you access.
  94 .Pp
  95 Your
  96 .Pa crater
  97 account is set up for CVS repository only. It can
  98 only operate as a CVS slave and cannot be logged into.  That is,
  99 .Pa crater.dragonflybsd.org
 100 is only used as part of
 101 .Nm cvs Fl d Ar ...
 102 operations.
 103 .Pp
 104 Your
 105 .Pa leaf
 106 account is a general developer account.  Any
 107 .Dx
 108 developer can have a
 109 .Pa leaf
 110 account, whether a committer or not.
 111 It can be useful as a developer rendezvous,
 112 however.  For example, people upload kernel cores to
 113 .Pa leaf
 114 so other
 115 developers can look at them.  You log into your
 116 .Pa leaf
 117 account with:
 118 .Pp
 119 .Li ssh you@leaf.dragonflybsd.org
 120 .Pp
 121 The rules for account use are in
 122 .Pa leaf Ap s
 123 MOTD.
 124 It is very important that you never install a password or create a SSH
 125 key pair on
 126 .Pa leaf
 127 to use to access other machines.
 128 Because non-committers can have
 129 .Pa leaf
 130 accounts, since
 131 .Pa leaf
 132 is not considered
 133 a secure machine.
 134 .Sh TESTING COMMIT ACCESS
 135 There is a directory called
 136 .Pa /usr/src/test/test .
 137 To test your commit
 138 access, try making a modification and committing a file in this
 139 directory.
 140 .Pp
 141 .Bd -literal -offset indent
 142 cd /usr/src/test/test
 143 (edit something)
 144 cvs -d you@crater.dragonflybsd.org:/cvs commit file_you_edited
 145 .Ed
 146 .Sh COMITTING REAL WORK
 147 Make modifications as needed.  For example, edit files.  If adding
 148 new files make CVS aware of them like this.  Files can just be
 149 added locally, but directories have to run through
 150 .Pa crater .
 151 These
 152 operations do not actually affect the repository (except directories
 153 being added are mkdir'd in the repository).  Instead they are
 154 stored in the checkout source's
 155 .Pa CVS/
 156 subdirectory and then
 157 synchronized to the repository when you
 158 .Nm cvs Cm commit .
 159 .Pp
 160 .Bd -literal -offset indent
 161 cvs add filename
 162 cvs -d you@crater.dragonflybsd.org:/cvs add directory
 163 .Ed
 164 .Pp
 165 To commit to the repository, use:
 166 .Bd -literal -offset indent
 167 cvs -d you@crater.dragonflybsd.org:/cvs commit files_or_directories
 168 .Ed
 169 .Pp
 170 Do not set
 171 .Ev CVSROOT
 172 to
 173 .Pa you@crater.dragonflybsd.org:/cvs .
 174 The reason is that you want the default
 175 .Ev CVSROOT
 176 in your checked out
 177 sources to point at your local CVS repository, not at
 178 .Pa crater .
 179 This reduces instances where accidental commits or repository
 180 operations are made on
 181 .Pa crater .
 182 .Pp
 183 It is best to avoid
 184 .Nm cvs Cm update Ap ing
 185 directly from the repository.
 186 e.g. try to avoid doing
 187 .Nm cvs Fl d Ar ... Cm update
 188 directly from
 189 .Pa crater .
 190 Instead, use
 191 .Xr cvsup 1
 192 to resync your local copy of the repository
 193 and use
 194 .Nm cvs Cm update
 195 or
 196 .Nm cvs Fl d Ar /home/dcvs Cm update
 197 to update from
 198 your local copy of the repository.
 199 .Pp
 200 The idea here is to try to avoid having CVS set its
 201 .Pa CVS/Root
 202 file in any given checked out CVS directory to point at
 203 .Pa crater .
 204 You really want it to just point at your local copy of the CVS
 205 repository.
 206 .Pp
 207 Never do
 208 .Nm cvs Cm tag
 209 or
 210 .Cm rtag
 211 operations.  Such operations can be
 212 very dangerous and only highly experienced CVS admins should
 213 do them.  That's basically just two or three people (Matt and Joerg
 214 primarily).
 215 .Pp
 216 The best way to resynchronize your local CVS repository after
 217 making a commit is to cvsup again.
 218 .Sh DISCUSSING COMMITTABLE WORK BEFORE HAND
 219 Discussion prior to commit usually occurs on the kernel@, submit@, or bugs@
 220 mailing lists.  It depends on the work involved.  Simple and obvious work,
 221 such as documentation edits or additions, don't really need a head's up.
 222 .Pp
 223 Simple and obvious bug fixes don't need a head's up, other than to
 224 say that you will (or just have) committed the fix, so you don't
 225 race other committers trying to do the same thing.  Usually the
 226 developer most active in a discussion about a bug commits the
 227 fix, but it isn't considered a big deal.
 228 .Pp
 229 More complex issues are usually discussed on the lists first.
 230 Non-trivial but straight forward bug fixes usually go through
 231 a testing period, where you say something like:
 232 .Do
 233 Here is a patch
 234 to driver BLAH that fixes A, B, and C, please test it.  If there
 235 are no objections I will commit it next Tuesday.
 236 .Dc
 237 (usually a week,
 238 or more depending on the complexity of the patch).
 239 .Pp
 240 New drivers or utilities are usually discussed.  Committers will
 241 often commit new work
 242 .Em without
 243 hooking it into the buildworld or
 244 buildkernel infrastructure in order to be able to continue
 245 development on it in piecemeal without having to worry about it
 246 breaking buildworld or buildkernel, and then they hook it in as a
 247 last step after they've stabilized it.  Examples of this include
 248 new versions of GCC, updates to vendor packages such as bind,
 249 sendmail, etc.
 250 .Sh DEVELOPER LOCKS
 251 Areas within the CVS repository are never explicitly locked.
 252 Often situations will arise where one developer commits work and
 253 another developer finds an issue with it that needs to be corrected.
 254 .Pp
 255 All committed work becomes community property.  No developer has a
 256 .Sq lock
 257 on any part of the source tree.  However, if a developer is
 258 actively working on a portion of the source tree and you find a bug
 259 or other issue, courtesy dictates that you post to kernel@ and/or
 260 email the developer.
 261 .Pp
 262 This means that, generally, if you do not see a commit to an area
 263 of the source tree in the last few weeks, it isn't considered active and
 264 you don't really need to confer with the developer that made the
 265 commit, though you should still post to the kernel@ mailing list
 266 and, of course, confer with developers when their expertise is
 267 needed.
 268 .Pp
 269 One exception to this rule is documentation.  If any developer commits
 270 new work, the documentation guys have free reign to go in and
 271 correct
 272 .Xr mdoc 7
 273 errors.  This is really a convenience as most developers
 274 are not
 275 .Xr mdoc 7
 276 gurus and it's a waste of time for the doc guys to post
 277 to kernel@ for all the little corrections they make.
 278 .Sh CONFLICTS
 279 On the occasion that a major code conflict occurs, for example if two
 280 people are doing major work in the same area of the source tree and forgot
 281 to collaborate with each other, the project leader will be responsible for
 282 resolving the conflict.  Again, the repository is considered community
 283 property and it must be acceptable for any developer to be able to work on
 284 any area of the tree that he or she has an interest in.
 285 .Sh MAJOR ARCHITECTURAL CHANGES
 286 This is generally Matt Dillon's area of expertise.  All major architectural
 287 changes must be discussed on the kernel@ mailing list and he retains
 288 veto power.
 289 .Pp
 290 This isn't usually an issue with any work.  At best if something
 291 doesn't look right architecturally he'll chip in with adjustments to
 292 make it fit in.  Nothing ever really gets vetoed.
 293 .Sh SEE ALSO
 294 .Xr cvs 1 ,
 295 .Xr cvsup 1 ,
 296 .Xr development 7