1 .\" Copyright (c) 2018 Edward Tomasz Napierala <trasz@FreeBSD.org>
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 development is split into three major suprojects: doc, ports, and src.
37 Doc is the documentation, such as the
42 .Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/
44 Ports, described further in
46 are the way to build, package, and install third party software.
49 .Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/
51 The last one, src, revolves around the source code for the base system,
52 consisting of the kernel, and the libraries and utilities commonly called
55 The Committer's Guide, describing topics relevant to all committers,
58 .Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/
61 src development takes place in the CURRENT branch in Subversion,
64 .Lk https://svn.FreeBSD.org/base/head
66 There is also a read-only GitHub mirror at:
68 .Lk https://github.com/freebsd/freebsd
70 Changes are first committed to CURRENT and then usually merged back
72 Every few years the CURRENT branch is renamed to STABLE, and a new
73 CURRENT is branched, with an incremented major version number.
74 Releases are then branched off STABLE and numbered with consecutive minor
77 Layout of the source tree is described in
79 Build instructions can be found in
83 Kernel programming interfaces (KPIs) are documented in section 9
87 Regression test suite is described in
89 For coding conventions, see
92 To ask questions regarding development, use the mailing lists,
93 such as freebsd-arch@ and freebsd-hackers@:
95 .Lk https://lists.FreeBSD.org
97 To get your patches integrated into the main
99 repository use Phabricator;
100 it is a code review tool that allows other developers to review the changes,
101 suggest improvements, and, eventually, allows them to pick up the change and
104 .Lk https://reviews.FreeBSD.org
108 build and test status of CURRENT and STABLE branches,
109 the continuous integration system is at:
111 .Lk https://ci.FreeBSD.org
114 Check out the CURRENT branch, build it, and install, overwriting the current
116 .Bd -literal -offset indent
117 svnlite co https://svn.FreeBSD.org/base/head src
119 make -sj8 buildworld buildkernel installkernel
124 .Bd -literal -offset indent
126 make -j8 installworld
130 Rebuild and reinstall a single piece of userspace, in this
133 .Bd -literal -offset indent
135 make clean all install
138 Quickly rebuild and reinstall the kernel, only recompiling the files
139 changed since last build; note that this will only work if the full kernel
140 build has been completed in the past, not on a fresh source tree:
141 .Bd -literal -offset indent
143 make -sj8 kernel KERNFAST=1
148 for another CPU architecture,
149 first prepare your source tree by building the cross-toolchain:
150 .Bd -literal -offset indent
152 make -sj8 toolchain TARGET_ARCH=armv6
155 Afterwards, to build and install a single piece of userspace, use:
156 .Bd -literal -offset indent
158 make buildenv TARGET_ARCH=armv6
159 make clean all install DESTDIR=/clients/arm
162 Likewise, to quickly rebuild and reinstall the kernel, use:
163 .Bd -literal -offset indent
165 make buildenv TARGET_ARCH=armv6
166 make -sj8 kernel KERNFAST=1 DESTDIR=/clients/arm
181 manual page was originally written by
182 .An Matthew Dillon Aq Mt dillon@FreeBSD.org
187 It was since extensively modified by
188 .An Eitan Adler Aq Mt eadler@FreeBSD.org
189 to reflect the repository conversion from
193 It was rewritten from scratch by
194 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org