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 project-hosted
62 Git repository, located at:
64 .Lk https://git.FreeBSD.org/src.git
68 .Lk ssh://git@gitrepo.FreeBSD.org/src.git
70 There is also a list of public, read-only Git mirrors at:
72 .Lk https://docs.freebsd.org/en/books/handbook/mirrors/#external-mirrors
76 Git branch represents CURRENT;
77 all changes are first committed to CURRENT and then usually cherry-picked
78 back to STABLE, which refers to Git branches such as
80 Every few years a new STABLE is branched from CURRENT,
81 with an incremented major version number.
82 Releases are then branched off STABLE and numbered with consecutive minor
85 Layout of the source tree is described in
87 Build instructions can be found in
91 Kernel programming interfaces (KPIs) are documented in section 9
95 Regression test suite is described in
97 For coding conventions, see
100 To ask questions regarding development, use the mailing lists,
101 such as freebsd-arch@ and freebsd-hackers@:
103 .Lk https://lists.FreeBSD.org
105 To get your patches integrated into the main
107 repository use Phabricator;
108 it is a code review tool that allows other developers to review the changes,
109 suggest improvements, and, eventually, allows them to pick up the change and
112 .Lk https://reviews.FreeBSD.org
116 build and test status of CURRENT and STABLE branches,
117 the continuous integration system is at:
119 .Lk https://ci.FreeBSD.org
122 Check out the CURRENT branch, build it, and install, overwriting the current
124 .Bd -literal -offset indent
125 git clone https://git.FreeBSD.org/src.git src
127 make -sj8 buildworld buildkernel installkernel
132 .Bd -literal -offset indent
134 make -j8 installworld
138 Rebuild and reinstall a single piece of userspace, in this
141 .Bd -literal -offset indent
143 make clean all install
146 Quickly rebuild and reinstall the kernel, only recompiling the files
147 changed since last build; note that this will only work if the full kernel
148 build has been completed in the past, not on a fresh source tree:
149 .Bd -literal -offset indent
151 make -sj8 kernel KERNFAST=1
156 for another CPU architecture,
157 first prepare your source tree by building the cross-toolchain:
158 .Bd -literal -offset indent
160 make -sj8 toolchain TARGET_ARCH=armv6
163 Afterwards, to build and install a single piece of userspace, use:
164 .Bd -literal -offset indent
166 make buildenv TARGET_ARCH=armv6
167 make clean all install DESTDIR=/clients/arm
170 Likewise, to quickly rebuild and reinstall the kernel, use:
171 .Bd -literal -offset indent
173 make buildenv TARGET_ARCH=armv6
174 make -sj8 kernel KERNFAST=1 DESTDIR=/clients/arm
189 manual page was originally written by
190 .An Matthew Dillon Aq Mt dillon@FreeBSD.org
195 It was since extensively modified by
196 .An Eitan Adler Aq Mt eadler@FreeBSD.org
197 to reflect the repository conversion from
201 It was rewritten from scratch by
202 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org