Changeset View
Changeset View
Standalone View
Standalone View
share/man/man7/build.7
Show All 18 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd August 5, 2020 | .Dd September 6, 2020 | ||||
.Dt BUILD 7 | .Dt BUILD 7 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm build | .Nm build | ||||
.Nd information on how to build the system | .Nd General instructions on how to build the system | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The sources for the | The sources for the | ||||
.Fx | .Fx | ||||
system and its applications are contained in three different directories, | system and its applications are contained in three different directories, | ||||
normally | normally | ||||
.Pa /usr/src , | .Pa /usr/src , | ||||
.Pa /usr/doc , | .Pa /usr/doc , | ||||
and | and | ||||
Show All 20 Lines | |||||
.Xr ports 7 . | .Xr ports 7 . | ||||
.Pp | .Pp | ||||
The | The | ||||
.Xr make 1 | .Xr make 1 | ||||
command is used in each of these directories to build and install the | command is used in each of these directories to build and install the | ||||
things in that directory. | things in that directory. | ||||
Issuing the | Issuing the | ||||
.Xr make 1 | .Xr make 1 | ||||
command in any directory or | command in any directory issues the | ||||
subdirectory of those directories has the same effect as issuing the | .Xr make 1 | ||||
same command in all subdirectories of that directory. | command recursively in all subdirectories. | ||||
With no target specified, the things in that directory are just built. | With no target specified, the items in the directories are built | ||||
and no further action is taken. | |||||
.Pp | .Pp | ||||
A source tree is allowed to be read-only. | A source tree is allowed to be read-only. | ||||
As described in | As described in | ||||
.Xr make 1 , | .Xr make 1 , | ||||
objects are usually built in a separate object directory hierarchy | objects are usually built in a separate object directory hierarchy | ||||
specified by the environment variable | specified by the environment variable | ||||
.Va MAKEOBJDIRPREFIX , | .Va MAKEOBJDIRPREFIX , | ||||
or under | or under | ||||
.Pa /usr/obj | .Pa /usr/obj | ||||
if variable | if variable | ||||
.Va MAKEOBJDIRPREFIX | .Va MAKEOBJDIRPREFIX | ||||
is not set. | is not set. | ||||
The canonical object directory is described in the documentation for the | The canonical object directory is described in the documentation for the | ||||
.Cm buildworld | .Cm buildworld | ||||
target below. | target below. | ||||
.Pp | .Pp | ||||
The build may be controlled by defining | The build may be controlled by defining | ||||
.Xr make 1 | .Xr make 1 | ||||
variables described in the | variables described in the | ||||
.Sx ENVIRONMENT | .Sx ENVIRONMENT | ||||
section below, and by the variables documented in | section below, and by the variables documented in | ||||
.Xr make.conf 5 . | .Xr make.conf 5 . | ||||
.Pp | .Pp | ||||
The default components included in the build are specified in the file | |||||
.Pa /etc/src.conf | |||||
in the source tree. | |||||
To override the default file, include the SRCCONF option in the make steps, | |||||
pointing to a custom src.conf file. | |||||
For more information see | |||||
.Xr src.conf 5 . | |||||
.Pp | |||||
The following list provides the names and actions for the targets | The following list provides the names and actions for the targets | ||||
supported by the build system: | supported by the build system: | ||||
.Bl -tag -width ".Cm cleandepend" | .Bl -tag -width ".Cm cleandepend" | ||||
.It Cm analyze | .It Cm analyze | ||||
Run Clang static analyzer against all objects and present output on stdout. | Run Clang static analyzer against all objects and present output on stdout. | ||||
.It Cm check | .It Cm check | ||||
Run tests for a given subdirectory. | Run tests for a given subdirectory. | ||||
The default directory used is | The default directory used is | ||||
▲ Show 20 Lines • Show All 474 Lines • ▼ Show 20 Lines | |||||
as part of the | as part of the | ||||
.Cm buildkernel | .Cm buildkernel | ||||
and | and | ||||
.Cm installkernel | .Cm installkernel | ||||
process. | process. | ||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||
make PORTS_MODULES=emulators/kqemu-kmod kernel | make PORTS_MODULES=emulators/kqemu-kmod kernel | ||||
.Ed | .Ed | ||||
.It Va SRCCONF | |||||
Specify a file to override the default | |||||
.Pa /etc/src.conf . | |||||
The src.conf file controls the components to build. | |||||
See | |||||
.Xr SRC.CONF 5 | |||||
imp: lower case here. | |||||
.It Va STRIPBIN | .It Va STRIPBIN | ||||
Command to use at install time when stripping binaries. | Command to use at install time when stripping binaries. | ||||
Be sure to add any additional tools required to run | Be sure to add any additional tools required to run | ||||
.Va STRIPBIN | .Va STRIPBIN | ||||
to the | to the | ||||
.Va LOCAL_ITOOLS | .Va LOCAL_ITOOLS | ||||
.Xr make 1 | .Xr make 1 | ||||
variable before running the | variable before running the | ||||
▲ Show 20 Lines • Show All 263 Lines • Show Last 20 Lines |
lower case here.