1.\" Copyright (c) 2018 Edward Tomasz Napierala <trasz@FreeBSD.org> 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 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. 11.\" 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 22.\" SUCH DAMAGE. 23.\" 24.\" $FreeBSD$ 25.\" 26.Dd November 1, 2021 27.Dt DEVELOPMENT 7 28.Os 29.Sh NAME 30.Nm development 31.Nd introduction to 32.Fx 33development process 34.Sh DESCRIPTION 35.Fx 36development is split into three major subprojects: doc, ports, and src. 37Doc is the documentation, such as the 38.Fx 39Handbook. 40To read more, see: 41.Pp 42.Lk https://www.FreeBSD.org/doc/en/books/fdp-primer/ 43.Pp 44Ports, described further in 45.Xr ports 7 , 46are the way to build, package, and install third party software. 47To read more, see: 48.Pp 49.Lk https://www.FreeBSD.org/doc/en/books/porters-handbook/ 50.Pp 51The last one, src, revolves around the source code for the base system, 52consisting of the kernel, and the libraries and utilities commonly called 53the world. 54.Pp 55The Committer's Guide, describing topics relevant to all committers, 56can be found at: 57.Pp 58.Lk https://www.FreeBSD.org/doc/en/articles/committers-guide/ 59.Pp 60.Fx 61src development takes place in the project-hosted 62Git repository, located at: 63.Pp 64.Lk https://git.FreeBSD.org/src.git 65.Pp 66The push URL is: 67.Pp 68.Lk ssh://git@gitrepo.FreeBSD.org/src.git 69.Pp 70There is also a list of public, read-only Git mirrors at: 71.Pp 72.Lk https://docs.freebsd.org/en/books/handbook/mirrors/#external-mirrors 73.Pp 74The 75.Ql main 76Git branch represents CURRENT; 77all changes are first committed to CURRENT and then usually cherry-picked 78back to STABLE, which refers to Git branches such as 79.Ql stable/13 . 80Every few years a new STABLE is branched from CURRENT, 81with an incremented major version number. 82Releases are then branched off STABLE and numbered with consecutive minor 83numbers. 84.Pp 85Layout of the source tree is described in 86.Xr hier 7 . 87Build instructions can be found in 88.Xr build 7 89and 90.Xr release 7 . 91Kernel programming interfaces (KPIs) are documented in section 9 92manual pages; use 93.Ql "apropos -s 9 ." 94for a list. 95Regression test suite is described in 96.Xr tests 7 . 97For coding conventions, see 98.Xr style 9 . 99.Pp 100To ask questions regarding development, use the mailing lists, 101such as freebsd-arch@ and freebsd-hackers@: 102.Pp 103.Lk https://lists.FreeBSD.org 104.Pp 105To get your patches integrated into the main 106.Fx 107repository use Phabricator; 108it is a code review tool that allows other developers to review the changes, 109suggest improvements, and, eventually, allows them to pick up the change and 110commit it: 111.Pp 112.Lk https://reviews.FreeBSD.org 113.Pp 114To check the latest 115.Fx 116build and test status of CURRENT and STABLE branches, 117the continuous integration system is at: 118.Pp 119.Lk https://ci.FreeBSD.org 120.Pp 121.Sh EXAMPLES 122Check out the CURRENT branch, build it, and install, overwriting the current 123system: 124.Bd -literal -offset indent 125git clone https://git.FreeBSD.org/src.git src 126cd src 127make -sj8 buildworld buildkernel installkernel 128shutdown -r now 129.Ed 130.Pp 131After reboot: 132.Bd -literal -offset indent 133cd src 134make -j8 installworld 135reboot 136.Ed 137.Pp 138Rebuild and reinstall a single piece of userspace, in this 139case 140.Xr ls 1 : 141.Bd -literal -offset indent 142cd src/bin/ls 143make clean all install 144.Ed 145.Pp 146Quickly rebuild and reinstall the kernel, only recompiling the files 147changed since last build; note that this will only work if the full kernel 148build has been completed in the past, not on a fresh source tree: 149.Bd -literal -offset indent 150cd src 151make -sj8 kernel KERNFAST=1 152.Ed 153.Pp 154To rebuild parts of 155.Fx 156for another CPU architecture, 157first prepare your source tree by building the cross-toolchain: 158.Bd -literal -offset indent 159cd src 160make -sj8 toolchain TARGET_ARCH=aarch64 161.Ed 162.Pp 163Afterwards, to build and install a single piece of userspace, use: 164.Bd -literal -offset indent 165cd src/bin/ls 166make buildenv TARGET_ARCH=aarch64 167make clean all install DESTDIR=/clients/arm 168.Ed 169.Pp 170Likewise, to quickly rebuild and reinstall the kernel, use: 171.Bd -literal -offset indent 172cd src 173make buildenv TARGET_ARCH=aarch64 174make -sj8 kernel KERNFAST=1 DESTDIR=/clients/arm 175.Ed 176.Sh SEE ALSO 177.Xr git 1 , 178.Xr witness 4 , 179.Xr build 7 , 180.Xr hier 7 , 181.Xr ports 7 , 182.Xr release 7 , 183.Xr tests 7 , 184.Xr locking 9 , 185.Xr style 9 186.Sh HISTORY 187The 188.Nm 189manual page was originally written by 190.An Matthew Dillon Aq Mt dillon@FreeBSD.org 191and first appeared 192in 193.Fx 5.0 , 194December 2002. 195It was since extensively modified by 196.An Eitan Adler Aq Mt eadler@FreeBSD.org 197to reflect the repository conversion from 198.Xr cvs 1 199to 200.Xr svn 1 . 201It was rewritten from scratch by 202.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 203for 204.Fx 12.0 . 205