View | Details | Raw Unified | Return to bug 203863
Collapse All | Expand All

(-)man5/src.conf.5 (-9 / +7 lines)
Lines 2-8 Link Here
2 
.\" from FreeBSD: head/tools/build/options/makeman 287942 2015-09-17 22:04:46Z bdrewery
 2 
.\" from FreeBSD: head/tools/build/options/makeman 287942 2015-09-17 22:04:46Z bdrewery
3 
.\" $FreeBSD$
 3 
.\" $FreeBSD$
4 
.Dd September 18, 2015
 4 
.Dd September 18, 2015
5 
.Dt SRC.CONF 5
 5 
.Dt src.conf 5
6 
.Os
 6 
.Os
7 
.Sh NAME
 7 
.Sh NAME
8 
.Nm src.conf
 8 
.Nm src.conf
Lines 10-24 Link Here
10 
.Sh DESCRIPTION
 10 
.Sh DESCRIPTION
11 
The
 11 
The
12 
.Nm
 12 
.Nm
13 
file contains settings that will apply to every build involving the
 13 
file contains variables that control what components will be generated during the build process
14 
of the
14 
.Fx
 15 
.Fx
15 
source tree; see
 16 
source tree (/usr/src); see
16 
.Xr build 7 .
 17 
.Xr build 7 .
17 
.Pp
 18 
.Pp
18 
The
 19 
The
19 
.Nm
 20 
.Nm
20 
file uses the standard makefile syntax.
 21 
file uses the standard makefile syntax. However,
21 
However,
22 
.Nm
 22 
.Nm
23 
should not specify any dependencies to
 23 
should not specify any dependencies to
24 
.Xr make 1 .
 24 
.Xr make 1 .
Lines 39-46 Link Here
39 
Overriding the location of
 39 
Overriding the location of
40 
.Nm
 40 
.Nm
41 
may be necessary if the system-wide settings are not suitable
 41 
may be necessary if the system-wide settings are not suitable
42 
for a particular build.
 42 
for a particular build. For instance, setting
43 
For instance, setting
44 
.Va SRCCONF
 43 
.Va SRCCONF
45 
to
 44 
to
46 
.Pa /dev/null
 45 
.Pa /dev/null
Lines 82-89 Link Here
82 
.Dq Li FALSE
 81 
.Dq Li FALSE
83 
or
 82 
or
84 
.Dq Li NO .
 83 
.Dq Li NO .
85 
Just the existence of an option will cause
 84 
Just the existence of an option will cause it to be honoured by
86 
it to be honoured by
87 
.Xr make 1 .
 85 
.Xr make 1 .
88 
.Pp
 86 
.Pp
89 
The following list provides a name and short description for variables
 87 
The following list provides a name and short description for variables
(-)man7/build.7 (-25 / +32 lines)
Lines 25-35 Link Here
25 
.\" $FreeBSD$
 25 
.\" $FreeBSD$
26 
.\"
 26 
.\"
27 
.Dd December 31, 2014
 27 
.Dd December 31, 2014
28 
.Dt BUILD 7
 28 
.Dt Build 7
29 
.Os
 29 
.Os
30 
.Sh NAME
 30 
.Sh NAME
31 
.Nm build
 31 
.Nm build
32 
.Nd information on how to build the system
 32 
.Nd General instructions on how to build the system
33 
.Sh DESCRIPTION
 33 
.Sh DESCRIPTION
34 
The sources for the
 34 
The sources for the
35 
.Fx
 35 
.Fx
Lines 66-97 Link Here
66 
things in that directory.
 66 
things in that directory.
67 
Issuing the
 67 
Issuing the
68 
.Xr make 1
 68 
.Xr make 1
69 
command in any directory or
 69 
command in any directory issues the
70 
subdirectory of those directories has the same effect as issuing the
 70 
.Xr make 1
71 
same command in all subdirectories of that directory.
 71 
command recursively in all subdirectories.
72 
With no target specified, the things in that directory are just built.
 72 
With no target specified, the items in the directories are built
73 
and no further action is taken.
73 
.Pp
 74 
.Pp
74 
A source tree is allowed to be read-only.
 75 
A source tree is allowed to be read-only as all build artifcats generated by
75 
As described in
 76 
.Xr make 1
76 
.Xr make 1 ,
 77 
are generated in
77 
objects are usually built in a separate object directory hierarchy
78 
specified by the environment variable
79 
.Va MAKEOBJDIRPREFIX ,
80 
or under
81 
.Pa /usr/obj
 78 
.Pa /usr/obj
82 
if variable
 79 
by default. The destination directory can be changed by specifying
80 
a new location using
83 
.Va MAKEOBJDIRPREFIX
 81 
.Va MAKEOBJDIRPREFIX
84 
is not set.
 82 
as described in
85 
For a given source directory, its canonical object directory
 83 
.Xr make 1 .
86 
would be
 84 

            

            

              87
              
.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}


              85
              
Therefore, for a given source directory, its build artifacts 

            

            

              88
              
if


              86
              
would be generated in

            

            

              89
              
.Xr make 1


              87
              
.Pa /usr/obj/${.CURDIR}

            

            

              90
              
variable


              88
              
or to

            

            

              
              

              89
              
.Pa ${MAKEOBJDIRPREFIX}/${.CURDIR}

            

            


              90
              
according to the 

            

        

          91
          
.Va MAKEOBJDIRPREFIX

          91
          
.Va MAKEOBJDIRPREFIX

        

          
            

              92
              
is set, or


              92
              
variable.

            

            

              93
              
.Pa /usr/obj${.CURDIR}


              
              
            

            

              94
              
if this variable is not set.


            

        

          95
          
Cross-builds set the object directory as described in the

          93
          
Cross-builds set the object directory as described in the

        

        

          96
          
documentation for the

          94
          
documentation for the

        

        

          97
          
.Cm buildworld

          95
          
.Cm buildworld

        

  

    
      
            Lines 102-109
          
      
      
        Link Here
      
    
  

        

          102
          
variables described in the

          100
          
variables described in the

        

        

          103
          
.Sx ENVIRONMENT

          101
          
.Sx ENVIRONMENT

        

        

          104
          
section below, and by the variables documented in

          102
          
section below, and by the variables documented in

        

          
            

              105
              
.Xr make.conf 5 .


              103
              
.Xr make.conf 5 . 

            

        

          106
          
.Pp

          104
          
.Pp

        

            

              
              
              105
              
The default components included in the build are specified in the file 

            

            

              106
              
/etc/src.conf in the source tree. To override the default file, include 

            

            

              107
              
the SRCCONF option in the make steps, pointing to a custom src.conf 

            

            

              108
              
file. For more information see 

            

            

              109
              
.Xr src.conf 5 .

            

            

              110
              
.Pp

            

        

          107
          
The following list provides the names and actions for the targets

          111
          
The following list provides the names and actions for the targets

        

        

          108
          
supported by the build system:

          112
          
supported by the build system:

        

        

          109
          
.Bl -tag -width ".Cm cleandepend"

          113
          
.Bl -tag -width ".Cm cleandepend"

        

  

    
      
            Lines 445-450
          
      
      
        Link Here
      
    
  

        

          445
          
.Bd -literal -offset indent

          449
          
.Bd -literal -offset indent

        

        

          446
          
make PORTS_MODULES=emulators/kqemu-kmod kernel

          450
          
make PORTS_MODULES=emulators/kqemu-kmod kernel

        

        

          447
          
.Ed

          451
          
.Ed

        

            

              
              
              452
              
.It Va SRCCONF

            

            

              453
              
Specify a file to override the default /etc/src.conf. The src.conf file controls the components to build. See 

            

            

              454
              
.Xr SRC.CONF 5

            

        

          448
          
.It Va STRIPBIN

          455
          
.It Va STRIPBIN

        

        

          449
          
Command to use at install time when stripping binaries.

          456
          
Command to use at install time when stripping binaries.

        

        

          450
          
Be sure to add any additional tools required to run

          457
          
Be sure to add any additional tools required to run

        






  

  Return to bug 203863