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 March 13, 2018 28.Dt DEVELOPMENT 7 29.Os 30.Sh NAME 31.Nm development 32.Nd introduction to FreeBSD development process 33.Sh DESCRIPTION 34.Fx 35development is split into three major suprojects: doc, ports, and src. 36Doc is the documentation, such as the FreeBSD Handbook. 37To read more, see: 38.Pp 39.Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/ 40.Pp 41Ports, described further in 42.Xr ports 7 , 43are the way to build, package, and install third party software. 44To read more, see: 45.Pp 46.Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/ 47.Pp 48The last one, src, revolves around the source code for the base system, 49consisting of the kernel, and the libraries and utilities commonly called 50the world. 51.Pp 52The Committer's Guide, describing topics relevant to all committers, 53can be found at: 54.Pp 55.Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/ 56.Pp 57FreeBSD src development takes place in the CURRENT branch in Subversion, 58located at: 59.Pp 60.Lk http://svn.FreeBSD.org/base/head 61.Pp 62There is also a read-only GitHub mirror at: 63.Pp 64.Lk https://github.com/freebsd/freebsd 65.Pp 66Changes are first committed to CURRENT and then usually merged back 67to STABLE. 68Every few years the CURRENT branch is renamed to STABLE, and a new 69CURRENT is branched, with an incremented major version number. 70Releases are then branched off STABLE and numbered with consecutive minor numbers. 71.Pp 72Layout of the source tree is described in 73.Xr hier 7 . 74Build instructions can be found in 75.Xr build 7 76and 77.Xr release 7 . 78For coding conventions, see 79.Xr style 9 . 80.Pp 81To ask questions regarding development, use the mailing lists, 82such as freebsd-arch@ and freebsd-hackers@: 83.Pp 84.Lk https://lists.FreeBSD.org/ 85.Pp 86To get your patches integrated into the main freebsd repository use Phabricator; 87it is a code review tool that allows other developers to review the changes, 88suggest improvements, and, eventually, allows them to pick up the change and 89commit it: 90.Pp 91.Lk https://reviews.FreeBSD.org 92.Pp 93.Sh EXAMPLES 94Check out the CURRENT branch, build it, and install, overwriting the current 95system: 96.Dl svnlite co https://svn.FreeBSD.org/base/head src 97.Dl cd src 98.Dl make -j8 buildworld buildkernel installkernel 99.Dl reboot 100.Pp 101After reboot: 102.Dl cd src 103.Dl make -j8 installworld 104.Pp 105.Sh SEE ALSO 106.Xr witness 4 , 107.Xr build 7 , 108.Xr hier 7 , 109.Xr release 7 , 110.Xr locking 9 , 111.Xr style 9 112.Sh HISTORY 113The 114.Nm 115manual page was originally written by 116.An Matthew Dillon Aq Mt dillon@FreeBSD.org 117and first appeared 118in 119.Fx 5.0 , 120December 2002. 121It was since extensively modified by 122.An Eitan Adler Aq Mt eadler@FreeBSD.org 123to reflect the repository conversion from 124.Xr cvs 1 125to 126.Xr svn 1 . 127It was rewritten from scratch by 128.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 129for 130.Fx 12.0 . 131