1.\" Copyright (c) 2018 Edward Tomasz Napierala <trasz@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd May 11, 2018 28.Dt DEVELOPMENT 7 29.Os 30.Sh NAME 31.Nm development 32.Nd introduction to 33.Fx 34development process 35.Sh DESCRIPTION 36.Fx 37development is split into three major suprojects: doc, ports, and src. 38Doc is the documentation, such as the 39.Fx 40Handbook. 41To read more, see: 42.Pp 43.Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/ 44.Pp 45Ports, described further in 46.Xr ports 7 , 47are the way to build, package, and install third party software. 48To read more, see: 49.Pp 50.Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/ 51.Pp 52The last one, src, revolves around the source code for the base system, 53consisting of the kernel, and the libraries and utilities commonly called 54the world. 55.Pp 56The Committer's Guide, describing topics relevant to all committers, 57can be found at: 58.Pp 59.Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/ 60.Pp 61.Fx 62src development takes place in the CURRENT branch in Subversion, 63located at: 64.Pp 65.Lk https://svn.FreeBSD.org/base/head 66.Pp 67There is also a read-only GitHub mirror at: 68.Pp 69.Lk https://github.com/freebsd/freebsd 70.Pp 71Changes are first committed to CURRENT and then usually merged back 72to STABLE. 73Every few years the CURRENT branch is renamed to STABLE, and a new 74CURRENT is branched, with an incremented major version number. 75Releases are then branched off STABLE and numbered with consecutive minor 76numbers. 77.Pp 78Layout of the source tree is described in 79.Xr hier 7 . 80Build instructions can be found in 81.Xr build 7 82and 83.Xr release 7 . 84Kernel APIs are usually documented, use 85.Ql "apropos -s 9 ''" 86for a list. 87Regression test suite is described in 88.Xr tests 7 . 89For coding conventions, see 90.Xr style 9 . 91.Pp 92To ask questions regarding development, use the mailing lists, 93such as freebsd-arch@ and freebsd-hackers@: 94.Pp 95.Lk https://lists.FreeBSD.org/ 96.Pp 97To get your patches integrated into the main 98.Fx 99repository use Phabricator; 100it is a code review tool that allows other developers to review the changes, 101suggest improvements, and, eventually, allows them to pick up the change and 102commit it: 103.Pp 104.Lk https://reviews.FreeBSD.org/ 105.Sh EXAMPLES 106Check out the CURRENT branch, build it, and install, overwriting the current 107system: 108.Bd -literal -offset indent 109svnlite co https://svn.FreeBSD.org/base/head src 110cd src 111make -j8 buildworld buildkernel installkernel 112reboot 113.Ed 114.Pp 115After reboot: 116.Bd -literal -offset indent 117cd src 118make -j8 installworld 119.Ed 120.Sh SEE ALSO 121.Xr svnlite 1 , 122.Xr witness 4 , 123.Xr build 7 , 124.Xr hier 7 , 125.Xr release 7 , 126.Xr locking 9 , 127.Xr style 9 128.Sh HISTORY 129The 130.Nm 131manual page was originally written by 132.An Matthew Dillon Aq Mt dillon@FreeBSD.org 133and first appeared 134in 135.Fx 5.0 , 136December 2002. 137It was since extensively modified by 138.An Eitan Adler Aq Mt eadler@FreeBSD.org 139to reflect the repository conversion from 140.Xr cvs 1 141to 142.Xr svn 1 . 143It was rewritten from scratch by 144.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 145for 146.Fx 12.0 . 147