version 1.19, 2002/12/08 22:14:01 |
version 1.31, 2003/05/10 07:12:37 |
|
|
toolchain (make is not required); all other tools are created as part of |
toolchain (make is not required); all other tools are created as part of |
the NetBSD build process. |
the NetBSD build process. |
|
|
Note: A couple host toolchain components are not yet available in |
Note: A couple of host toolchain components are not yet available |
the tools directory. Also, some tools use non-POSIX, non-ANSI C |
in the tools directory. Also, some tools use non-POSIX, non-ANSI C |
extensions and need to be standardized. As a result, cross-compil- |
extensions and need to be standardized. As a result, cross-compil- |
ing from systems other than NetBSD is not currently supported. |
ing from systems other than NetBSD is not currently supported. |
|
|
|
|
|
|
distrib/, etc/ |
distrib/, etc/ |
Sources for items used when making a full release snap- |
Sources for items used when making a full release snap- |
shot, such as files installed in /etc on the destination |
shot, such as files installed in DESTDIR/etc on the desti- |
system, boot media, and release notes. |
nation system, boot media, and release notes. |
|
|
regress/ Regression test harness. Can be cross-compiled, but only |
regress/ Regression test harness. Can be cross-compiled, but only |
run natively. |
run natively. |
|
|
Default: Empty string if USETOOLS is ``yes''; unset other- |
Default: Empty string if USETOOLS is ``yes''; unset other- |
wise. |
wise. |
|
|
|
Note: build.sh will provide a default of destdir.MACHINE (in |
|
the top-level .OBJDIR) unless run in `expert' mode |
|
|
MAKECONF The name of the make(1) configuration file. Only settable in |
MAKECONF The name of the make(1) configuration file. Only settable in |
the process environment. |
the process environment. |
|
|
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
MKDOC Can be set to ``yes'' or ``no''. Indicates whether system |
MKDOC Can be set to ``yes'' or ``no''. Indicates whether system |
documentation destined for /usr/share/doc will be installed |
documentation destined for DESTDIR/usr/share/doc will be in- |
during a build. |
stalled during a build. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) |
MKLINT Can be set to ``yes'' or ``no''. Indicates whether lint(1) |
will be run against portions of the NetBSD source code during |
will be run against portions of the NetBSD source code during |
the build, and whether lint libraries will be installed into |
the build, and whether lint libraries will be installed into |
/usr/libdata/lint. |
DESTDIR/usr/libdata/lint. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
code. |
code. |
|
|
MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files |
MKSHARE Can be set to ``yes'' or ``no''. Indicates whether files |
destined to reside in /usr/share will be built and installed |
destined to reside in DESTDIR/usr/share will be built and in- |
during a build. If set to ``no'', then all of MKCATPAGES, |
stalled during a build. If set to ``no'', then all of |
MKDOC, MKINFO, MKMAN, and MKNLS will be set to ``no'' uncon- |
MKCATPAGES, MKDOC, MKINFO, MKMAN, and MKNLS will be set to |
ditionally. |
``no'' unconditionally. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
|
|
These variables only affect the top level ``Makefile'' and do not affect |
These variables only affect the top level ``Makefile'' and do not affect |
manually building subtrees of the NetBSD source code. |
manually building subtrees of the NetBSD source code. |
|
|
MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether object |
INSTALLWORLDDIR Location for the ``make installworld'' target to install |
directories will be created automatically (via a ``make |
to. |
obj'' pass) at the start of a build. |
|
|
Default: ``/'' |
|
|
|
MKOBJDIRS Can be set to ``yes'' or ``no''. Indicates whether ob- |
|
ject directories will be created automatically (via a |
|
``make obj'' pass) at the start of a build. |
|
|
Default: ``yes'' |
Default: ``yes'' |
|
|
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see be- |
NBUILDJOBS Now obsolete. Use the make(1) option -j, instead (see |
low) |
below) |
|
|
Default: Unset. |
Default: Unset. |
|
|
NOCLEANDIR If set, avoids the ``make cleandir'' phase of a full |
NOCLEANDIR If set, avoids the ``make cleandir'' phase of a full |
build. This has the effect of allowing only changed files |
build. This has the effect of allowing only changed |
in a source tree to be recompiled. This can speed up |
files in a source tree to be recompiled. This can speed |
builds when updating only a few files in the tree. |
up builds when updating only a few files in the tree. |
|
|
Default: Unset. |
Default: Unset. |
|
|
NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full |
NODISTRIBDIRS If set, avoids the ``make distrib-dirs'' phase of a full |
build. This skips running mtree(8) on DESTDIR, useful on |
build. This skips running mtree(8) on DESTDIR, useful |
systems where building as an unprivileged user, or where |
on systems where building as an unprivileged user, or |
it is known that the system-wide mtree files have not |
where it is known that the system-wide mtree files have |
changed. |
not changed. |
|
|
Default: Unset. |
Default: Unset. |
|
|
NOINCLUDES If set, avoids the ``make includes'' phase of a full |
NOINCLUDES If set, avoids the ``make includes'' phase of a full |
build. This has the effect of preventing make(1) from |
build. This has the effect of preventing make(1) from |
thinking that some programs are out-of-date simply because |
thinking that some programs are out-of-date simply be- |
the system include files have changed. However, this op- |
cause the system include files have changed. However, |
tion should not be used when updating the entire NetBSD |
this option should not be used when updating the entire |
source tree arbitrarily; it is suggested to use UPDATE in |
NetBSD source tree arbitrarily; it is suggested to use |
that case. |
UPDATE in that case. |
|
|
Default: Unset. |
Default: Unset. |
|
|
RELEASEDIR If set, specifies the directory to which a release(7) lay- |
RELEASEDIR If set, specifies the directory to which a release(7) |
out will be written at the end of a ``make release''. |
layout will be written at the end of a ``make release''. |
|
|
Default: Unset. |
Default: Unset. |
|
|
UPDATE If set, then in addition to the effects described for UP- |
Note: build.sh will provide a default of releasedir (in |
DATE above, this implies the effects of NOCLEANDIR. |
the top-level .OBJDIR) unless run in `expert' mode |
|
|
|
UPDATE If set, then in addition to the effects described for |
|
UPDATE above, this implies the effects of NOCLEANDIR |
|
(i.e., ``make cleandir'' is avoided). |
|
|
BUILDING |
BUILDING |
"make" command line options |
"make" command line options |
|
|
fore any system libraries or programs can be built. |
fore any system libraries or programs can be built. |
|
|
install Install programs, libraries, and documentation into DESTDIR. |
install Install programs, libraries, and documentation into DESTDIR. |
Few files will be installed to /dev, /etc, /root or /var in |
Few files will be installed to DESTDIR/dev, DESTDIR/etc, |
order to prevent user supplied configuration data from being |
DESTDIR/root or DESTDIR/var in order to prevent user supplied |
overwritten. |
configuration data from being overwritten. |
|
|
lint Run lint(1) against the C source code, where appropriate, and |
lint Run lint(1) against the C source code, where appropriate, and |
generate system-installed lint libraries. |
generate system-installed lint libraries. |
|
|
Additional make(1) targets are usable specifically from the top source |
Additional make(1) targets are usable specifically from the top source |
level to facilitate building the entire NetBSD source tree. |
level to facilitate building the entire NetBSD source tree. |
|
|
build Build the entire NetBSD system. This orders portions of the |
build Build the entire NetBSD system. This orders portions of |
source tree such that prerequisites will be built in the prop- |
the source tree such that prerequisites will be built in |
er order. |
the proper order. |
|
|
release Do a ``make build'', then package the system into a standard |
distribution Do a ``make build'', and then install a full distribution |
release layout as described by release(7). This requires that |
into DESTDIR, including files in DESTDIR/dev, DESTDIR/etc, |
RELEASEDIR be set (see above). |
DESTDIR/root and DESTDIR/var. |
|
|
|
buildworld As per ``make distribution'', except that it ensures that |
|
DESTDIR is not the root directory. |
|
|
|
installworld Install the distribution from DESTDIR to INSTALLWORLDDIR |
|
(which defaults to the root directory). Ensures that |
|
INSTALLWORLDDIR is the not root directory if cross compil- |
|
ing. |
|
|
|
Note: It is highly recommended that you upgrade your kernel |
|
and reboot before performing this operation. |
|
|
|
sets Create distribution sets from DESTDIR into |
|
RELEASEDIR/MACHINE/binary/sets. Should be run after ``make |
|
distribution'' (as ``make build'' does not install all of |
|
the required files). |
|
|
|
sourcesets Create source sets of the source tree into |
|
RELEASEDIR/source/sets. |
|
|
|
release Do a ``make distribution'', build kernels, distribution me- |
|
dia, and install sets (this as per ``make sets''), and then |
|
package the system into a standard release layout as de- |
|
scribed by release(7). This requires that RELEASEDIR be |
|
set (see above). |
|
|
regression-tests |
regression-tests |
Can only be run after building the regression tests in the di- |
Can only be run after building the regression tests in the |
rectory ``regress''. Runs the compiled regression tests on |
directory ``regress''. Runs the compiled regression tests |
the local host. |
on the local host. |
|
|
The "build.sh" script |
The "build.sh" script |
This script file is a Bourne shell script designed to build the entire |
This script file is a Bourne shell script designed to build the entire |
|
|
of options below, variables that are automatically set by build.sh are |
of options below, variables that are automatically set by build.sh are |
noted where applicable. |
noted where applicable. |
|
|
The following are available command line options that may be supplied to |
The following operations are supported by build.sh: |
build.sh: |
|
|
build Build the system as per ``make build''. This option im- |
|
plies the obj and tools operations. |
|
|
|
distribution Build a full distribution as per ``make distribution''. |
|
This option implies the build operation. |
|
|
|
release Build a full release as per ``make release''. This option |
|
implies the distribution operation. |
|
|
|
makewrapper Create the nbmake-MACHINE wrapper. This operation is auto- |
|
matically performed for any of the other operations. |
|
|
|
obj Perform ``make obj''. |
|
|
|
tools Build and install the host tools from src/tools. |
|
|
|
kernel=kconf Build a new kernel. The kconf argument is the name of a |
|
configuration file suitable for use by config(8). If kconf |
|
does not contain any `/' characters, the configuration file |
|
is expected to be found in the KERNCONFDIR directory, which |
|
is typically sys/arch/MACHINE/conf. The new kernel will be |
|
built in a subdirectory of KERNOBJDIR, which is typically |
|
sys/arch/MACHINE/compile or an associated object directory. |
|
In order to ensure that the kernel is built using up-to- |
|
date tools, it is strongly recommended that the tools be |
|
rebuilt (using the tools operation). |
|
|
|
install=idir Install the contents of DESTDIR to idir, using ``make |
|
installworld''. |
|
|
|
sets Perform ``make sets''. |
|
|
|
sourcesets Perform ``make sourcesets''. |
|
|
|
The following command line options alter the behaviour of the above oper- |
|
ations: The following command line options alter the behaviour of the |
|
build.sh operations described above: |
|
|
-a arch Set the value of MACHINE_ARCH to arch. |
-a arch Set the value of MACHINE_ARCH to arch. |
|
|
|
|
that the resulting name is of the form ``nbmake-MACHINE- |
that the resulting name is of the form ``nbmake-MACHINE- |
BUILDID''. |
BUILDID''. |
|
|
-b Bootstrap ``make'' and create a nbmake-MACHINE script (see be- |
|
low). |
|
|
|
-D dest Set the value of DESTDIR to dest. |
-D dest Set the value of DESTDIR to dest. |
|
|
-d Build a full distribution. This differs from a default build |
-E Set `expert' mode. This overrides various sanity checks, and |
in that files will also be installed to /dev, /etc, /root and |
allows: DESTDIR does not have to be set to a non-root path for |
/var. Note this does not build a ``release''; no release sets |
builds, and UNPRIVED does not have to be set when building as a |
are placed in ${RELEASEDIR}. -d is implied by -R. |
non-root user. |
|
|
-E Set `expert' mode; DESTDIR does not have to be set to a non- |
Note: It is highly recommended that you know what you are doing |
root path for builds when this is set. |
when you use this option. |
|
|
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
-j njob Passed through to make(1). Makefiles should use .WAIT or have |
explicit dependancies as necessary to enforce build ordering. |
explicit dependancies as necessary to enforce build ordering. |
If you see build failures with -j, please save complete build |
If you see build failures with -j, please save complete build |
logs so the failures can be analyzed. |
logs so the failures can be analyzed. |
|
|
-k kernel |
|
Build a new kernel. The kernel argument is the name of a con- |
|
figuration file suitable for use by config(8). If kernel does |
|
not contain any `/' characters, the configuration file is ex- |
|
pected to be found in the KERNCONFDIR directory, which is typi- |
|
cally sys/arch/MACHINE/conf. The new kernel will be built in a |
|
subdirectory of KERNOBJDIR, which is typically |
|
sys/arch/MACHINE/compile or an associated object directory. In |
|
order to ensure that the kernel is built using up-to-date |
|
tools, it is strongly recommended that the tools be rebuilt |
|
(using the -t option) in a separate invocation of build.sh pri- |
|
or to using the -k option, or that the -t and -k options be |
|
used together in a single invocation of build.sh. |
|
|
|
-M obj Set MAKEOBJDIRPREFIX to obj. |
-M obj Set MAKEOBJDIRPREFIX to obj. |
|
|
-m mach Set the value of MACHINE to mach. This will also override any |
-m mach Set the value of MACHINE to mach. This will also override any |
|
|
|
|
-o Set the value of MKOBJDIRS to ``no''. |
-o Set the value of MKOBJDIRS to ``no''. |
|
|
-R rel Set the value of RELEASEDIR to rel. Setting this option will |
-R rel Set the value of RELEASEDIR to rel. |
cause build.sh to run ``make release'' instead of ``make |
|
build''. |
|
|
|
-r Remove the contents of DESTDIR and TOOLDIR before building |
-r Remove the contents of DESTDIR and TOOLDIR before building |
(provides a clean starting point). This will skip deleting |
(provides a clean starting point). This will skip deleting |
|
|
``make'' will only be rebuilt as needed (when the source files |
``make'' will only be rebuilt as needed (when the source files |
for make(1) change). |
for make(1) change). |
|
|
-t Build and install the host tools from src/tools only. This op- |
|
tion implies -b. |
|
|
|
-U Set the UNPRIVED variable. |
-U Set the UNPRIVED variable. |
|
|
-u Set the UPDATE variable. |
-u Set the UPDATE variable. |
|
|
|
-V var=[value] |
|
Set the variable var to value (which is optional). |
|
|
-w wrapper |
-w wrapper |
Create the nbmake wrapper script (see below) in a custom loca- |
Create the nbmake wrapper script (see below) in a custom loca- |
tion, specified by wrapper. This allows, for instance, to |
tion, specified by wrapper. This allows, for instance, to |
|
|
with an absolute path. |
with an absolute path. |
|
|
EXAMPLES |
EXAMPLES |
./build.sh -t |
1. ./build.sh tools kernel=GENERIC |
Build a new toolchain. |
|
|
Build a new toolchain, and use the new toolchain to configure and |
|
build a new GENERIC kernel. |
|
|
|
2. ./build.sh -U distribution |
|
|
|
Using unprivileged mode, build a complete distribution to a DESTDIR |
|
directory that build.sh selects (and will display). |
|
|
|
3. # ./build.sh -U install=/ |
|
|
|
As root, install to / the distribution that was built by example 2. |
|
Even though this is run as root, -U is required so that the permis- |
|
sions stored in DESTDIR/METALOG are correctly applied to the files |
|
as they're copied to /. |
|
|
|
4. ./build.sh -U -u release |
|
|
cd ${KERNCONFDIR} ; ${TOOLDIR}/bin/nbconfig GENERIC |
Using unprivileged mode, build a complete release to DESTDIR and |
Use the new version of config(8) to prepare to build a new |
RELEASEDIR directories that build.sh selects (and will display). |
GENERIC kernel. |
UPDATE (-u) is set to prevent the ``make cleandir'', so that if this |
|
is run after example 2, it doesn't need to redo that portion of the |
cd ${KERNOBJDIR}/GENERIC ; ${TOOLDIR}/bin/nbmake-${MACHINE} dependall |
release build. |
Use the new toolchain to build a new GENERIC kernel. |
|
|
|
./build.sh -t -k GENERIC |
|
Build a new toolchain, and use the new toolchain to configure |
|
and build a new GENERIC kernel. |
|
|
|
./build.sh -U -d |
|
Using unprivileged mode, build a complete distribution in |
|
DESTDIR. |
|
|
|
./build.sh -U -R /some/dir/RELEASE |
|
Using unprivileged mode, build a complete release in the speci- |
|
fied release directory. |
|
|
|
OBSOLETE VARIABLES |
OBSOLETE VARIABLES |
NBUILDJOBS Use the make(1) option -j, instead. |
NBUILDJOBS Use the make(1) option -j, instead. |
|
|
BUGS |
BUGS |
A few platforms are not yet using this build system. |
A few platforms are not yet using this build system. |
|
|
NetBSD December 8, 2002 9 |
NetBSD May 8, 2003 10 |