1 .\" Copyright (c) 2018 Edward Tomasz Napierala <trasz@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd introduction to FreeBSD development process
35 development is split into three major suprojects: doc, ports, and src.
36 Doc is the documentation, such as the FreeBSD Handbook.
39 .Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/
41 Ports, described further in
43 are the way to build, package, and install third party software.
46 .Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/
48 The last one, src, revolves around the source code for the base system,
49 consisting of the kernel, and the libraries and utilities commonly called
52 The Committer's Guide, describing topics relevant to all committers,
55 .Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/
57 FreeBSD src development takes place in the CURRENT branch in Subversion,
60 .Lk http://svn.FreeBSD.org/base/head
62 There is also a read-only GitHub mirror at:
64 .Lk https://github.com/freebsd/freebsd
66 Changes are first committed to CURRENT and then usually merged back
68 Every few years the CURRENT branch is renamed to STABLE, and a new
69 CURRENT is branched, with an incremented major version number.
70 Releases are then branched off STABLE and numbered with consecutive minor numbers.
72 Layout of the source tree is described in
74 Build instructions can be found in
78 For coding conventions, see
81 To ask questions regarding development, use the mailing lists,
82 such as freebsd-arch@ and freebsd-hackers@:
84 .Lk https://lists.FreeBSD.org/
86 To get your patches integrated into the main freebsd repository use Phabricator;
87 it is a code review tool that allows other developers to review the changes,
88 suggest improvements, and, eventually, allows them to pick up the change and
91 .Lk https://reviews.FreeBSD.org
94 Check out the CURRENT branch, build it, and install, overwriting the current
96 .Dl svnlite co https://svn.FreeBSD.org/base/head src
98 .Dl make -j8 buildworld buildkernel installkernel
103 .Dl make -j8 installworld
115 manual page was originally written by
116 .An Matthew Dillon Aq Mt dillon@FreeBSD.org
121 It was since extensively modified by
122 .An Eitan Adler Aq Mt eadler@FreeBSD.org
123 to reflect the repository conversion from
127 It was rewritten from scratch by
128 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org