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
37 development is split into three major suprojects: doc, ports, and src.
38 Doc is the documentation, such as the
43 .Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/
45 Ports, described further in
47 are the way to build, package, and install third party software.
50 .Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/
52 The last one, src, revolves around the source code for the base system,
53 consisting of the kernel, and the libraries and utilities commonly called
56 The Committer's Guide, describing topics relevant to all committers,
59 .Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/
62 src development takes place in the CURRENT branch in Subversion,
65 .Lk https://svn.FreeBSD.org/base/head
67 There is also a read-only GitHub mirror at:
69 .Lk https://github.com/freebsd/freebsd
71 Changes are first committed to CURRENT and then usually merged back
73 Every few years the CURRENT branch is renamed to STABLE, and a new
74 CURRENT is branched, with an incremented major version number.
75 Releases are then branched off STABLE and numbered with consecutive minor
78 Layout of the source tree is described in
80 Build instructions can be found in
84 Kernel programming interfaces (KPIs) are documented in section 9
88 Regression test suite is described in
90 For coding conventions, see
93 To ask questions regarding development, use the mailing lists,
94 such as freebsd-arch@ and freebsd-hackers@:
96 .Lk https://lists.FreeBSD.org/
98 To get your patches integrated into the main
100 repository use Phabricator;
101 it is a code review tool that allows other developers to review the changes,
102 suggest improvements, and, eventually, allows them to pick up the change and
105 .Lk https://reviews.FreeBSD.org/
107 Check out the CURRENT branch, build it, and install, overwriting the current
109 .Bd -literal -offset indent
110 svnlite co https://svn.FreeBSD.org/base/head src
112 make -sj8 buildworld buildkernel installkernel
117 .Bd -literal -offset indent
119 make -j8 installworld
123 Rebuild and reinstall a single piece of userspace, in this
126 .Bd -literal -offset indent
128 make clean all install
131 Quickly rebuild and reinstall the kernel, only recompiling the files
132 changed since last build; note that this will only work if the full kernel
133 build has been completed in the past, not on a fresh source tree:
134 .Bd -literal -offset indent
136 make -sj8 kernel KERNFAST=1
141 for another CPU architecture,
142 first prepare your source tree by building the cross-toolchain:
143 .Bd -literal -offset indent
145 make -sj8 toolchain TARGET_ARCH=armv6
148 Afterwards, to build and install a single piece of userspace, use:
149 .Bd -literal -offset indent
151 make buildenv TARGET_ARCH=armv6
152 make clean all install DESTDIR=/clients/arm
155 Likewise, to quickly rebuild and reinstall the kernel, use:
156 .Bd -literal -offset indent
158 make buildenv TARGET_ARCH=armv6
159 make -sj8 kernel KERNFAST=1 DESTDIR=/clients/arm
172 manual page was originally written by
173 .An Matthew Dillon Aq Mt dillon@FreeBSD.org
178 It was since extensively modified by
179 .An Eitan Adler Aq Mt eadler@FreeBSD.org
180 to reflect the repository conversion from
184 It was rewritten from scratch by
185 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org