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 February 26, 2016 | .Dd March 29, 2016 | ||||
.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 information on how to build the system | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The sources for the | The sources for the | ||||
.Fx | .Fx | ||||
▲ Show 20 Lines • Show All 81 Lines • ▼ Show 20 Lines | |||||
.Pa ${CHECKDIR} . | .Pa ${CHECKDIR} . | ||||
.It Cm checkworld | .It Cm checkworld | ||||
Run the | Run the | ||||
.Fx | .Fx | ||||
test suite on installed world. | test suite on installed world. | ||||
.It Cm clean | .It Cm clean | ||||
Remove any files created during the build process. | Remove any files created during the build process. | ||||
.It Cm cleandepend | .It Cm cleandepend | ||||
Remove the file | Remove the | ||||
.Pa ${.OBJDIR}/${DEPENDFILE} | .Pa ${.OBJDIR}/${DEPENDFILE}* | ||||
generated by a prior | files generated by prior | ||||
.Dq Li "make" | |||||
wblock: Quotes are not needed here. They are only necessary when single parameter will be mistaken to… | |||||
and | |||||
.Dq Li "make depend" | .Dq Li "make depend" | ||||
step. | steps. | ||||
.It Cm cleandir | .It Cm cleandir | ||||
Remove the canonical object directory if it exists, or perform | Remove the canonical object directory if it exists, or perform | ||||
actions equivalent to | actions equivalent to | ||||
.Dq Li "make clean cleandepend" | .Dq Li "make clean cleandepend" | ||||
if it does not. | if it does not. | ||||
This target will also remove an | This target will also remove an | ||||
.Pa obj | .Pa obj | ||||
link in | link in | ||||
.Pa ${.CURDIR} | .Pa ${.CURDIR} | ||||
if that exists. | if that exists. | ||||
.Pp | .Pp | ||||
It is advisable to run | It is advisable to run | ||||
.Dq Li "make cleandir" | .Dq Li "make cleandir" | ||||
twice: the first invocation will remove the canonical object directory | twice: the first invocation will remove the canonical object directory | ||||
and the second one will clean up | and the second one will clean up | ||||
.Pa ${.CURDIR} . | .Pa ${.CURDIR} . | ||||
.It Cm depend | .It Cm depend | ||||
Generate a list of build dependencies in file | Generate a list of build dependencies in file | ||||
.Pa ${.OBJDIR}/${DEPENDFILE} . | .Pa ${.OBJDIR}/${DEPENDFILE} . | ||||
Per-object dependencies are generated at build time and stored in | |||||
.Pa ${.OBJDIR}/${DEPENDFILE}.${OBJ} . | |||||
.It Cm install | .It Cm install | ||||
Install the results of the build to the appropriate location in the | Install the results of the build to the appropriate location in the | ||||
installation directory hierarchy specified in variable | installation directory hierarchy specified in variable | ||||
.Va DESTDIR . | .Va DESTDIR . | ||||
.It Cm obj | .It Cm obj | ||||
Create the canonical object directory associated with the current | Create the canonical object directory associated with the current | ||||
directory. | directory. | ||||
.It Cm objlink | .It Cm objlink | ||||
▲ Show 20 Lines • Show All 250 Lines • ▼ Show 20 Lines | |||||
It defaults to | It defaults to | ||||
.Cm GENERIC . | .Cm GENERIC . | ||||
.It Va KERNFAST | .It Va KERNFAST | ||||
If set, the build target | If set, the build target | ||||
.Cm buildkernel | .Cm buildkernel | ||||
defaults to setting | defaults to setting | ||||
.Va NO_KERNELCLEAN , | .Va NO_KERNELCLEAN , | ||||
.Va NO_KERNELCONFIG , | .Va NO_KERNELCONFIG , | ||||
.Va NO_KERNELDEPEND | |||||
and | and | ||||
.Va NO_KERNELOBJ . | .Va NO_KERNELOBJ . | ||||
When set to a value other than | When set to a value other than | ||||
.Cm 1 | .Cm 1 | ||||
then | then | ||||
.Va KERNCONF | .Va KERNCONF | ||||
is set to the value of | is set to the value of | ||||
.Va KERNFAST . | .Va KERNFAST . | ||||
▲ Show 20 Lines • Show All 98 Lines • ▼ Show 20 Lines | |||||
.Pp | .Pp | ||||
Builds under directory | Builds under directory | ||||
.Pa /usr/src | .Pa /usr/src | ||||
are also influenced by defining one or more of the following symbols, | are also influenced by defining one or more of the following symbols, | ||||
using the | using the | ||||
.Fl D | .Fl D | ||||
option of | option of | ||||
.Xr make 1 : | .Xr make 1 : | ||||
.Bl -tag -width ".Va -DNO_KERNELDEPEND" | .Bl -tag -width ".Va -DNO_KERNELCONFIG" | ||||
.It Va NO_CLEANDIR | .It Va NO_CLEANDIR | ||||
If set, the build targets that clean parts of the object tree use the | If set, the build targets that clean parts of the object tree use the | ||||
equivalent of | equivalent of | ||||
.Dq make clean | .Dq make clean | ||||
instead of | instead of | ||||
.Dq make cleandir . | .Dq make cleandir . | ||||
.It Va NO_CLEAN | .It Va NO_CLEAN | ||||
If set, no object tree files are cleaned at all. | If set, no object tree files are cleaned at all. | ||||
Show All 18 Lines | |||||
If set, the build process does not run | If set, the build process does not run | ||||
.Dq make clean | .Dq make clean | ||||
as part of the | as part of the | ||||
.Cm buildkernel | .Cm buildkernel | ||||
target. | target. | ||||
.It Va NO_KERNELCONFIG | .It Va NO_KERNELCONFIG | ||||
If set, the build process does not run | If set, the build process does not run | ||||
.Xr config 8 | .Xr config 8 | ||||
as part of the | |||||
.Cm buildkernel | |||||
target. | |||||
.It Va NO_KERNELDEPEND | |||||
If set, the build process does not run | |||||
.Dq make depend | |||||
as part of the | as part of the | ||||
.Cm buildkernel | .Cm buildkernel | ||||
target. | target. | ||||
.It Va NO_KERNELOBJ | .It Va NO_KERNELOBJ | ||||
If set, the build process does not run | If set, the build process does not run | ||||
.Dq make obj | .Dq make obj | ||||
as part of the | as part of the | ||||
.Cm buildkernel | .Cm buildkernel | ||||
▲ Show 20 Lines • Show All 93 Lines • Show Last 20 Lines |
Quotes are not needed here. They are only necessary when single parameter will be mistaken to be multiples because of whitespace. No harm, though.