d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dd5a318ba3
freebsd-nq/share/man/man7/build.7

179 lines
5.3 KiB
Groff
Raw Normal View History

Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.\" Copyright (c) 2000
.\" Mike W. Meyer
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" 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
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Add delete-old and delete-old-libs targets: - removes obsolete files/dirs or libraries. - works in interactive (default) and batch mode - respects DISTDIR - documented in UPDATING and build(7) The head of the file ObsoleteFiles.inc contains instructions how to add obsolete files/dirs/libs to the list. Obviously one should add obsolete files to this list, when he removes a file/dir/lib from the basesystem. Additionally add check-old target: - allows re@ to check if a file on the obsolete list resurfaces Design goals: - allows full control by the user (default interactive mode) - possibility of scripted removal of obsolete files (batch mode) - opt-in removal of files (explicit list of files) - seperate removal of libs (2 delete targets) Important design decissions: - structured list of files to remove instead of a plain text file: * allows to remove additional files if a NO_foo knob is specified without the need to change the targets (no NO_foo knob is respected yet) - not using mtree like NetBSD does: * mtree doesn't has an interactive mode Discussed on: arch (long ago), current (this year) Additional input from: re (hrs) Approved by: mentor (joerg)
2005-07-23 14:23:30 +00:00
.Dd July 23, 2005
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Dt BUILD 7
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 15:31:11 +00:00
.Os
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Sh NAME
.Nm build
mdoc(7) police: normalize .Nd.
2001-04-18 15:54:10 +00:00
.Nd information on how to build the system
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Sh DESCRIPTION
The source for the
mdoc(7) police: removed duplicate .Os calls.
2000-12-14 12:40:48 +00:00
.Fx
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
system and applications are contained in three different directories,
normally
.Pa /usr/src ,
.Pa /usr/doc ,
and
.Pa /usr/ports .
.Pa /usr/src
contains the
.Dq "base system"
sources, which is loosely defined as the things required to rebuild
the system to a useful state.
.Pa /usr/doc
contains the source for the system documentation, excluding the manual
pages.
.Pa /usr/ports
is a tree that provides a consistent interface for building and
installing third party applications.
.Pp
The
.Xr make 1
command is used in each of these directories to build and install the
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
things in that directory.
Issuing the
.Xr make 1
command in any directory or
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
subdirectory of those directories has the same effect as issuing the
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
same command in all subdirectories of that directory.
With no target specified, the things in that directory are just built.
The following
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
list provides the names and actions for other targets:
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Bl -tag -width indent-two
.It Cm clean
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
Removes any files created during the build process.
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.It Cm install
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
Installs the results of the build for this directory.
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.It Cm update
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
Gets updated sources as configured in
.Pa /etc/make.conf .
.El
.Pp
The other
.Pa /usr/src
make targets are:
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Bl -tag -width indent-two
.It Cm buildworld
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
Rebuild everything but the kernel, configure files in
.Pa /etc ,
and release.
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.It Cm installworld
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
Install everything built by
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Cm buildworld .
Document 'kernel-toolchain'. Submitted by: Jeremie Le Hen <jeremie@le-hen.org>
2005-08-03 03:26:57 +00:00
.It Cm kernel-toolchain
Rebuild the tools needed for kernel compilation.
Use this if you did do a buildworld first.
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.It Cm buildkernel
Rebuild the kernel and the kernel modules.
.It Cm installkernel
Install the kernel and the kernel modules.
Fix a few markup nits in previous commit. Noticed by: ru, who else? :)
2005-02-25 00:40:46 +00:00
.It Cm reinstallkernel .
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
Reinstall the kernel and the kernel modules.
To be more complete, discuss 'make kernel' since we do cover buildkernel. Xref config.8. Bump doc date.
2005-02-24 03:46:36 +00:00
.It Cm kernel
Equivalent to
.Cm buildkernel
followed by
.Cm installkernel
Add delete-old and delete-old-libs targets: - removes obsolete files/dirs or libraries. - works in interactive (default) and batch mode - respects DISTDIR - documented in UPDATING and build(7) The head of the file ObsoleteFiles.inc contains instructions how to add obsolete files/dirs/libs to the list. Obviously one should add obsolete files to this list, when he removes a file/dir/lib from the basesystem. Additionally add check-old target: - allows re@ to check if a file on the obsolete list resurfaces Design goals: - allows full control by the user (default interactive mode) - possibility of scripted removal of obsolete files (batch mode) - opt-in removal of files (explicit list of files) - seperate removal of libs (2 delete targets) Important design decissions: - structured list of files to remove instead of a plain text file: * allows to remove additional files if a NO_foo knob is specified without the need to change the targets (no NO_foo knob is respected yet) - not using mtree like NetBSD does: * mtree doesn't has an interactive mode Discussed on: arch (long ago), current (this year) Additional input from: re (hrs) Approved by: mentor (joerg)
2005-07-23 14:23:30 +00:00
.It Cm delete-old
Delete obsolete base system files and directories interactively.
When -DBATCH_DELETE_OLD_FILES is specified at the command line,
- Move recently added dir into the correct section. - Add a note about the organisation of the sections. - Expand shell globs (they worked in a previous version of the delete-old target, but not in this one). - Use the correct way of checking for a native environment. [1] - Add some more obsolete files. - Fix some bad english. [1] Suggested by: ru [1] Approved by: mentor (joerg)
2005-07-29 21:45:46 +00:00
the delete operation will be non-interactive.
Add delete-old and delete-old-libs targets: - removes obsolete files/dirs or libraries. - works in interactive (default) and batch mode - respects DISTDIR - documented in UPDATING and build(7) The head of the file ObsoleteFiles.inc contains instructions how to add obsolete files/dirs/libs to the list. Obviously one should add obsolete files to this list, when he removes a file/dir/lib from the basesystem. Additionally add check-old target: - allows re@ to check if a file on the obsolete list resurfaces Design goals: - allows full control by the user (default interactive mode) - possibility of scripted removal of obsolete files (batch mode) - opt-in removal of files (explicit list of files) - seperate removal of libs (2 delete targets) Important design decissions: - structured list of files to remove instead of a plain text file: * allows to remove additional files if a NO_foo knob is specified without the need to change the targets (no NO_foo knob is respected yet) - not using mtree like NetBSD does: * mtree doesn't has an interactive mode Discussed on: arch (long ago), current (this year) Additional input from: re (hrs) Approved by: mentor (joerg)
2005-07-23 14:23:30 +00:00
.It Cm delete-old-libs
Delete obsolete base system libraries interactively.
This should only be used if no 3rd party software uses the libraries anymore.
When -DBATCH_DELETE_OLD_FILES is specified at the command line,
- Move recently added dir into the correct section. - Add a note about the organisation of the sections. - Expand shell globs (they worked in a previous version of the delete-old target, but not in this one). - Use the correct way of checking for a native environment. [1] - Add some more obsolete files. - Fix some bad english. [1] Suggested by: ru [1] Approved by: mentor (joerg)
2005-07-29 21:45:46 +00:00
the delete operation will be non-interactive.
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.El
.Pp
For more information about the ports build process, see
.Xr ports 7 .
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
.Sh ENVIRONMENT
Markup fix. Use .Va instead of .Ev. No content changes.
2002-03-15 23:34:17 +00:00
.Bl -tag -width ".Va TARGET_ARCH"
.It Va TARGET_ARCH
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
The target machine processor architecture.
Spell analogous properly. Found by: ispell(1)
2002-03-17 15:01:28 +00:00
This is analogous to the
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Dq Nm uname Fl p
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
output.
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
Set this to cross-build for a different architecture.
Markup fix. Use .Va instead of .Ev. No content changes.
2002-03-15 23:34:17 +00:00
.It Va TARGET
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
The target hardware platform.
Spell analogous properly. Found by: ispell(1)
2002-03-17 15:01:28 +00:00
This is analogous to the
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Dq Nm uname Fl m
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
output.
This is necessary to cross-build some target architectures.
For example, cross-building for PC98 machines requires
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Va TARGET_ARCH Ns = Ns Li i386
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
and
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.Va TARGET Ns = Ns Li pc98 .
Markup fix. Use .Va instead of .Ev. No content changes.
2002-03-15 23:34:17 +00:00
.It Va NO_WERROR
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
If defined, warnings will not cause the build to halt, even if the
makefile says otherwise.
Markup fix. Use .Va instead of .Ev. No content changes.
2002-03-15 23:34:17 +00:00
.It Va DESTDIR
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
The directory hierarchy where the resulting binaries will be
installed.
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
.El
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Sh FILES
mdoc(7) police: sort FILES.
2001-09-04 10:08:19 +00:00
.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.It Pa /etc/make.conf
.It Pa /usr/doc/Makefile
.It Pa /usr/doc/share/mk/doc.project.mk
.It Pa /usr/ports/Mk/bsd.port.mk
.It Pa /usr/ports/Mk/bsd.sites.mk
mdoc(7) police: tidy up.
2002-03-20 14:33:37 +00:00
.It Pa /usr/share/examples/etc/make.conf
mdoc(7) police: sort FILES.
2001-09-04 10:08:19 +00:00
.It Pa /usr/src/Makefile
.It Pa /usr/src/Makefile.inc1
Prepare for mdoc(7)NG.
2000-12-29 09:18:45 +00:00
.El
Add an example to explain the basic procedure to build the world. Suggested by: obrien
2000-11-23 14:00:26 +00:00
.Sh EXAMPLES
Replaced a way outdated and unsafe sequence of upgrading the system from sources with the link to the relevant section in src/UPDATING.
2004-08-13 12:59:46 +00:00
For an
Add an example to explain the basic procedure to build the world. Suggested by: obrien
2000-11-23 14:00:26 +00:00
.Dq approved
Replaced a way outdated and unsafe sequence of upgrading the system from sources with the link to the relevant section in src/UPDATING.
2004-08-13 12:59:46 +00:00
method of updating your system from the latest sources,
please see the
.Sx COMMON ITEMS
section in
.Pa src/UPDATING .
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
.Pp
The following sequence of commands can be used to cross-build the
system for the Alpha architecture on an i386 host:
.Bd -literal -offset indent
cd /usr/src
Add a description of the TARGET variable, and add more information about the TARGET_ARCH variable. (1) Add information about the DESTDIR variable. Add more examples for cross-building. (1) Submitted by: ru MFC after: 3 days
2002-03-15 23:29:24 +00:00
make TARGET_ARCH=alpha buildworld
make TARGET_ARCH=alpha DESTDIR=/clients/axp installworld
Add an ENVIRONMENT section, and document TARGET_ARCH and NO_WERROR. Add a cross-build example.
2002-03-14 09:38:24 +00:00
.Ed
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Sh SEE ALSO
Use a more generic name for the compiler cross-reference. (cc instead of gcc.) Suggested by: sheldonh (not sholdonh)
2000-11-23 14:44:45 +00:00
.Xr cc 1 ,
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Xr install 1 ,
.Xr make 1 ,
.Xr make.conf 5 ,
* Say that ps, top, etc, "may not work" with the new kernel, rather than "will not work", as in many cases they will. Suggested by: sholdonh * Add cross-references to reboot(8) and shutdown(8)
2000-11-23 14:19:50 +00:00
.Xr ports 7 ,
Reference release(7) in SEE ALSO.
2002-03-13 06:59:39 +00:00
.Xr release 7 ,
Fix a few markup nits in previous commit. Noticed by: ru, who else? :)
2005-02-25 00:40:46 +00:00
.Xr config 8 ,
Mention mergemaster(8). Submitted by: obrien
2000-11-24 10:22:08 +00:00
.Xr mergemaster 8 ,
* Say that ps, top, etc, "may not work" with the new kernel, rather than "will not work", as in many cases they will. Suggested by: sholdonh * Add cross-references to reboot(8) and shutdown(8)
2000-11-23 14:19:50 +00:00
.Xr reboot 8 ,
.Xr shutdown 8
Add two new manual pages to document the various options available in make.conf, and the /usr/src building process. PR: 22676 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: nik, sheldonh
2000-11-22 14:04:26 +00:00
.Sh AUTHORS
.An Mike W. Meyer Aq mwm@mired.org .
Reference in New Issue Copy Permalink