share/man/man7/development.7

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