[Midnightbsd-cvs] src [10289] U trunk/share/man/man7/tuning.7: update man 7
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Sun Jun 3 12:51:25 EDT 2018
Revision: 10289
http://svnweb.midnightbsd.org/src/?rev=10289
Author: laffer1
Date: 2018-06-03 12:51:25 -0400 (Sun, 03 Jun 2018)
Log Message:
-----------
update man 7
Modified Paths:
--------------
trunk/share/man/man7/Makefile
trunk/share/man/man7/adding_user.7
trunk/share/man/man7/ascii.7
trunk/share/man/man7/bsd.snmpmod.mk.7
trunk/share/man/man7/build.7
trunk/share/man/man7/c99.7
trunk/share/man/man7/clocks.7
trunk/share/man/man7/development.7
trunk/share/man/man7/environ.7
trunk/share/man/man7/ffs.7
trunk/share/man/man7/firewall.7
trunk/share/man/man7/hier.7
trunk/share/man/man7/hostname.7
trunk/share/man/man7/intro.7
trunk/share/man/man7/maclabel.7
trunk/share/man/man7/mailaddr.7
trunk/share/man/man7/mports.7
trunk/share/man/man7/operator.7
trunk/share/man/man7/release.7
trunk/share/man/man7/sdoc.7
trunk/share/man/man7/security.7
trunk/share/man/man7/sprog.7
trunk/share/man/man7/stdint.7
trunk/share/man/man7/sticky.7
trunk/share/man/man7/tuning.7
Added Paths:
-----------
trunk/share/man/man7/growfs.7
trunk/share/man/man7/tests.7
Property Changed:
----------------
trunk/share/man/man7/adding_user.7
trunk/share/man/man7/ascii.7
trunk/share/man/man7/bsd.snmpmod.mk.7
trunk/share/man/man7/build.7
trunk/share/man/man7/c99.7
trunk/share/man/man7/clocks.7
trunk/share/man/man7/development.7
trunk/share/man/man7/environ.7
trunk/share/man/man7/ffs.7
trunk/share/man/man7/firewall.7
trunk/share/man/man7/hier.7
trunk/share/man/man7/hostname.7
trunk/share/man/man7/intro.7
trunk/share/man/man7/maclabel.7
trunk/share/man/man7/mailaddr.7
trunk/share/man/man7/mports.7
trunk/share/man/man7/operator.7
trunk/share/man/man7/release.7
trunk/share/man/man7/sdoc.7
trunk/share/man/man7/security.7
trunk/share/man/man7/sprog.7
trunk/share/man/man7/stdint.7
trunk/share/man/man7/sticky.7
trunk/share/man/man7/tuning.7
Modified: trunk/share/man/man7/Makefile
===================================================================
--- trunk/share/man/man7/Makefile 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/Makefile 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,18 +1,21 @@
+# $MidnightBSD$
# @(#)Makefile 8.1 (Berkeley) 6/5/93
-# $FreeBSD: src/share/man/man7/Makefile,v 1.29.8.1 2006/01/25 13:22:58 harti Exp $
-# $MidnightBSD: src/share/man/man7/Makefile,v 1.4 2010/06/19 14:46:43 laffer1 Exp $
+# $FreeBSD: stable/10/share/man/man7/Makefile 284009 2015-06-05 00:46:49Z cperciva $
+.include <bsd.own.mk>
+
#MISSING: eqnchar.7 ms.7 term.7
MAN= adding_user.7 \
ascii.7 \
bsd.snmpmod.mk.7 \
build.7 \
+ clocks.7 \
c99.7 \
- clocks.7 \
development.7 \
environ.7 \
ffs.7 \
firewall.7 \
+ growfs.7 \
hier.7 \
hostname.7 \
intro.7 \
@@ -26,10 +29,10 @@
sprog.7 \
stdint.7 \
sticky.7 \
+ tests.7 \
tuning.7
MLINKS= intro.7 miscellaneous.7
-MLINKS+= mports.7 ports.7
MLINKS+= security.7 securelevel.7
MLINKS+= c99.7 c.7
MLINKS+= c99.7 c78.7
@@ -36,4 +39,15 @@
MLINKS+= c99.7 c89.7
MLINKS+= c99.7 c90.7
+.if ${MK_TESTS} != "no"
+ATF= ${.CURDIR}/../../../contrib/atf
+.PATH: ${ATF}/doc
+MAN+= atf.7
+
+CLEANFILES+= atf.7
+atf.7: atf.7.in
+ sed -e 's,__DOCDIR__,/usr/share/doc/atf,g' \
+ <"${ATF}/doc/atf.7.in" >atf.7
+.endif
+
.include <bsd.prog.mk>
Modified: trunk/share/man/man7/adding_user.7
===================================================================
--- trunk/share/man/man7/adding_user.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/adding_user.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)adduser.8 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/adding_user.7 198788 2009-11-02 12:35:38Z brueffer $
.\"
.Dd January 30, 2009
.Dt ADDING_USER 8
Property changes on: trunk/share/man/man7/adding_user.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/ascii.7
===================================================================
--- trunk/share/man/man7/ascii.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/ascii.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,9 +31,9 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)ascii.7 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/ascii.7 294443 2016-01-20 16:41:00Z emaste $
.\"
-.Dd June 5, 1993
+.Dd January 20, 2016
.Dt ASCII 7
.Os
.Sh NAME
@@ -46,7 +47,7 @@
set:
.Bd -literal -offset left
000 NUL 001 SOH 002 STX 003 ETX 004 EOT 005 ENQ 006 ACK 007 BEL
-010 BS 011 HT 012 NL 013 VT 014 NP 015 CR 016 SO 017 SI
+010 BS 011 HT 012 LF 013 VT 014 FF 015 CR 016 SO 017 SI
020 DLE 021 DC1 022 DC2 023 DC3 024 DC4 025 NAK 026 SYN 027 ETB
030 CAN 031 EM 032 SUB 033 ESC 034 FS 035 GS 036 RS 037 US
040 SP 041 ! 042 " 043 # 044 $ 045 % 046 & 047 '
@@ -68,7 +69,7 @@
set:
.Bd -literal -offset left
00 NUL 01 SOH 02 STX 03 ETX 04 EOT 05 ENQ 06 ACK 07 BEL
-08 BS 09 HT 0A NL 0B VT 0C NP 0D CR 0E SO 0F SI
+08 BS 09 HT 0A LF 0B VT 0C FF 0D CR 0E SO 0F SI
10 DLE 11 DC1 12 DC2 13 DC3 14 DC4 15 NAK 16 SYN 17 ETB
18 CAN 19 EM 1A SUB 1B ESC 1C FS 1D GS 1E RS 1F US
20 SP 21 ! 22 " 23 # 24 $ 25 % 26 & 27 '
@@ -90,7 +91,7 @@
set:
.Bd -literal -offset left
0 NUL 1 SOH 2 STX 3 ETX 4 EOT 5 ENQ 6 ACK 7 BEL
- 8 BS 9 HT 10 NL 11 VT 12 NP 13 CR 14 SO 15 SI
+ 8 BS 9 HT 10 LF 11 VT 12 FF 13 CR 14 SO 15 SI
16 DLE 17 DC1 18 DC2 19 DC3 20 DC4 21 NAK 22 SYN 23 ETB
24 CAN 25 EM 26 SUB 27 ESC 28 FS 29 GS 30 RS 31 US
32 SP 33 ! 34 " 35 # 36 $ 37 % 38 & 39 '
Property changes on: trunk/share/man/man7/ascii.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/bsd.snmpmod.mk.7
===================================================================
--- trunk/share/man/man7/bsd.snmpmod.mk.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/bsd.snmpmod.mk.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2005,2008
.\" Hartmut Brandt.
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/bsd.snmpmod.mk.7 211397 2010-08-16 15:18:30Z joel $
.\"
.Dd January 8, 2008
.Dt BSD.SNMPMOD.MK 7
Property changes on: trunk/share/man/man7/bsd.snmpmod.mk.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/build.7
===================================================================
--- trunk/share/man/man7/build.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/build.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2000
.\" Mike W. Meyer
.\"
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/build.7 316241 2017-03-30 06:02:39Z ngie $
.\"
-.Dd October 10, 2012
+.Dd March 22, 2017
.Dt BUILD 7
.Os
.Sh NAME
@@ -40,8 +41,7 @@
and
.Pa /usr/ports .
These directories may be initially empty or non-existent until updated with
-.Xr csup 1 ,
-.Xr svn 1 ,
+.Xr svn 1
or
.Xr portsnap 8 .
Directory
@@ -108,6 +108,16 @@
The following list provides the names and actions for the targets
supported by the build system:
.Bl -tag -width ".Cm cleandepend"
+.It Cm check
+Run tests for a given subdirectory.
+The default directory used is
+.Pa ${.OBJDIR} ,
+but the check directory can be changed with
+.Pa ${CHECKDIR} .
+.It Cm checkworld
+Run the
+.Fx
+test suite on installed world.
.It Cm clean
Remove any files created during the build process.
.It Cm cleandepend
@@ -180,6 +190,12 @@
.Pa etc ,
and
.Pa release .
+The object directory can be changed from the default
+.Pa /usr/obj
+by setting the
+.Pa MAKEOBJDIRPREFIX
+.Xr make 1
+variable.
The actual build location prefix used is
.Pa ${MAKEOBJDIRPREFIX}${.CURDIR}
for native builds, and
@@ -263,6 +279,12 @@
.Bl -tag -width ".Cm distributekernel"
.It Cm buildkernel
Rebuild the kernel and the kernel modules.
+The object directory can be changed from the default
+.Pa /usr/obj
+by setting the
+.Pa MAKEOBJDIRPREFIX
+.Xr make 1
+variable.
.It Cm installkernel
Install the kernel and the kernel modules to directory
.Pa ${DESTDIR}/boot/kernel ,
@@ -332,7 +354,7 @@
.Dq Li "make installworld" .
.It Cm delete-old-libs
Delete obsolete base system libraries interactively.
-This target should only be used if no 3rd party software uses these
+This target should only be used if no third party software uses these
libraries.
When
.Li -DBATCH_DELETE_OLD_FILES
@@ -411,8 +433,31 @@
is set to the value of
.Va KERNFAST .
.It Va LOCAL_DIRS
-If set, this variable supplies a list of additional directories to
-build, relative to the root of the source tree.
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm everything
+target.
+.It Va LOCAL_ITOOLS
+If set, this variable supplies a list of additional tools that are used by the
+.Cm installworld
+and
+.Cm distributeworld
+targets.
+.It Va LOCAL_LIB_DIRS
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm libraries
+target.
+.It Va LOCAL_MTREE
+If set, this variable supplies a list of additional mtrees relative to the
+root of the source tree to use as part of the
+.Cm hierarchy
+target.
+.It Va LOCAL_TOOL_DIRS
+If set, this variable supplies a list of additional directories relative to
+the root of the source tree to build as part of the
+.Cm build-tools
+target.
.It Va PORTS_MODULES
A list of ports with kernel modules that should be built and installed
as part of the
@@ -423,6 +468,21 @@
.Bd -literal -offset indent
make PORTS_MODULES=emulators/kqemu-kmod kernel
.Ed
+.It Va STRIPBIN
+Command to use at install time when stripping binaries.
+Be sure to add any additional tools required to run
+.Va STRIPBIN
+to the
+.Va LOCAL_ITOOLS
+.Xr make 1
+variable before running the
+.Cm distributeworld
+or
+.Cm installworld
+targets.
+See
+.Xr install 1
+for more details.
.It Va SUBDIR_OVERRIDE
Override the default list of sub-directories and only build the
sub-directory named in this variable.
@@ -488,7 +548,7 @@
.It Va NO_SHARE
If set, the build does not descend into the
.Pa /usr/src/share
-subdirectory (i.e., manpages, locale data files, timezone data files and
+subdirectory (i.e., manual pages, locale data files, timezone data files and
other
.Pa /usr/src/share
files will not be rebuild from their sources).
@@ -593,7 +653,6 @@
.Ed
.Sh SEE ALSO
.Xr cc 1 ,
-.Xr csup 1 ,
.Xr install 1 ,
.Xr make 1 ,
.Xr svn 1 ,
@@ -601,6 +660,7 @@
.Xr src.conf 5 ,
.Xr ports 7 ,
.Xr release 7 ,
+.Xr tests 7 ,
.Xr config 8 ,
.Xr mergemaster 8 ,
.Xr portsnap 8 ,
Property changes on: trunk/share/man/man7/build.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/c99.7
===================================================================
--- trunk/share/man/man7/c99.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/c99.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2007, 2010 Gabor Kovesdan. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -21,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/c99.7 250576 2013-05-12 16:43:26Z eadler $
.\"
.Dd May 30, 2011
.Dt C 7
@@ -70,7 +71,7 @@
complicated tasks.
In this case the provided system calls of the given operating system can be
used.
-To not loose the portability by using these system calls, the POSIX
+To not lose the portability by using these system calls, the POSIX
(Portable Operating System Interface) standard evolved.
It describes what functions should be available to keep portability.
Note, that POSIX is not a C standard, but an operating system standard
Property changes on: trunk/share/man/man7/c99.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/clocks.7
===================================================================
--- trunk/share/man/man7/clocks.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/clocks.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1996 Joerg Wunsch
.\"
@@ -25,7 +26,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/clocks.7 206622 2010-04-14 19:08:06Z uqs $
.\" "
.Dd January 18, 2008
.Dt CLOCKS 7
Property changes on: trunk/share/man/man7/clocks.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/development.7
===================================================================
--- trunk/share/man/man7/development.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/development.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 1998 Matthew Dillon. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -21,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/development.7 247913 2013-03-07 13:24:16Z gavin $
.\"
-.Dd May 02, 2012
+.Dd March 7, 2013
.Dt DEVELOPMENT 7
.Os
.Sh NAME
@@ -48,8 +49,6 @@
The methods described
here are as applicable to production installations as it is to development
environments.
-You need a good 12-17GB of disk space on one machine to make this work
-conveniently.
.Sh SETTING UP THE ENVIRONMENT ON THE MASTER SERVER
Your master server should always run a stable, production version of the
.Fx
@@ -60,11 +59,11 @@
unstable environment on your master server which could lead to a situation
where you lose the environment and/or cannot recover from a mistake.
.Pp
-Create a huge partition called
+Create a partition called
.Pa /FreeBSD .
-8-12GB is recommended.
+Approximately 20GB is recommended.
This partition will contain nearly all the development environment,
-including the CVS tree, broken-out source, and possibly even object files.
+including the subversion tree, broken-out source, and possibly even object files.
You are going to export this partition to your other machines via a
READ-ONLY NFS export so do not mix it with other more security-sensitive
partitions.
@@ -86,73 +85,22 @@
environments which are described later in this document.
I recommend a
.Pa /usr/obj
-partition of at least 5GB.
+partition of at least 12GB.
.Pp
On the master server, use
-.Xr csup 1
-to automatically pull down and maintain
+.Xr svn 1
+to pull down and maintain
the
.Fx
-CVS archive once a day.
+source.
The first pull will take a long time,
it is several gigabytes, but once you have it,
-the daily synchronizations will be quite small.
-.Bd -literal -offset 4n
-mkdir /FreeBSD/FreeBSD-CVS
-rm -rf /home/ncvs
-ln -s /FreeBSD/FreeBSD-CVS /home/ncvs
-.Ed
-.Pp
-The
-.Xr cron 8
-job should look something like this (please randomize the time of
-day!).
-Note that you can use the
-.Xr csup 1
-configuration file example directly from
-.Pa /usr/share/examples
-without modification by supplying appropriate arguments
-to
-.Xr csup 1 .
-.Bd -literal -offset 4n
-33 6 * * * /usr/bin/csup -r 20 -L 2 -h cvsup.freebsd.org /usr/share/examples/cvsup/cvs-supfile
-.Ed
-.Pp
-Run the
-.Xr csup 1
-manually the first time to pull down the archive.
-It could take
-all day depending on how fast your connection is!
-You will run all
-.Xr csup 1
-and
-.Xr cvs 1
+the updates will be quite small.
+Run all
+.Xr svn 1
operations as
.Dq Li root
-and you need to set up a
-.Pa ~/.cvsrc
-.Pq Pa /root/.cvsrc
-file, as shown below, for proper
-.Xr cvs 1
-operation.
-Using
-.Pa ~/.cvsrc
-to specify
-.Xr cvs 1
-defaults is an excellent way to
-.Dq "file and forget" ,
-but you should never forget that you put them in there.
-.Bd -literal -offset 4n
-# cvs -q
-diff -u
-update -Pd
-checkout -P
-.Ed
.Pp
-Now use
-.Xr cvs 1
-to check out a -STABLE source tree and a -CURRENT source tree,
-as well as ports and docs, to create your initial source environment.
Keeping the broken-out source and ports in
.Pa /FreeBSD
allows you to export
@@ -160,71 +108,16 @@
This also means you only need to edit/maintain files in one place and all
your clients automatically pick up the changes.
.Bd -literal -offset 4n
-mkdir /FreeBSD/FreeBSD-4.x
-mkdir /FreeBSD/FreeBSD-current
-
-cd /FreeBSD/FreeBSD-4.x
-cvs -d /home/ncvs checkout -rRELENG_4 src
-
-cd /FreeBSD/FreeBSD-current
-cvs -d /home/ncvs checkout src
-cvs -d /home/ncvs checkout ports
-cvs -d /home/ncvs checkout doc
-.Ed
-.Pp
-Now create a softlink for
-.Pa /usr/src
-and
-.Pa /usr/src2 .
-On the main server I always point
-.Pa /usr/src
-at -STABLE and
-.Pa /usr/src2
-at -CURRENT.
-On client machines I usually do not have a
-.Pa /usr/src2
-and I make
-.Pa /usr/src
-point at whatever version of
-.Fx
-the client box is intended to
-run.
-.Bd -literal -offset 4n
+mkdir /FreeBSD
+cd /FreeBSD
+svn co https://svn.freebsd.org/ports/head ports
+svn co https://svn.freebsd.org/doc/head doc
+svn co https://svn.freebsd.org/base/head src
cd /usr
-rm -rf src src2
-ln -s /FreeBSD/FreeBSD-4.x/src src (could be -CURRENT on a client)
-ln -s /FreeBSD/FreeBSD-current/src src2 (MASTER SERVER ONLY)
+rm -rf src
+ln -s /FreeBSD/src src
.Ed
.Pp
-Now you have to make a choice for
-.Pa /usr/obj .
-Well, hopefully you made it already and chose the partition method.
-If you
-chose poorly you probably intend to put it in
-.Pa /FreeBSD
-and, if so, this is
-what you want to do:
-.Bd -literal -offset 4n
-(ONLY IF YOU MADE A POOR CHOICE AND PUT /usr/obj in /FreeBSD!)
-mkdir /FreeBSD/obj
-cd /usr
-rm -rf obj
-ln -s /FreeBSD/obj obj
-.Ed
-.Pp
-Alternatively you may chose simply to leave
-.Pa /usr/obj
-in
-.Pa /usr .
-If your
-.Pa /usr
-is large enough this will work, but I do not recommend it for
-safety reasons
-.Pa ( /usr/obj
-is constantly being modified,
-.Pa /usr
-is not).
-.Pp
Note that exporting
.Pa /usr/obj
via read-only NFS to your other boxes will
@@ -240,19 +133,17 @@
It is far easier to do builds on the master server and then only do installs
on the clients.
.Pp
-I usually maintain my ports tree via CVS.
-It is sitting right there in the master CVS archive and I have even told you
-to check it out (see above).
+I usually maintain my ports tree via svn or portsnap.
With some fancy softlinks you can make the ports tree available both on your
master server and on all of your other machines.
-Note that the ports tree exists only on the HEAD CVS branch, so its always
--CURRENT even on a -STABLE box.
+Note that the ports tree exists only on the HEAD ports branch, so its always
+usable even on a -STABLE box.
This is what you do:
.Bd -literal -offset 4n
(THESE COMMANDS ON THE MASTER SERVER AND ON ALL CLIENTS)
cd /usr
rm -rf ports
-ln -s /FreeBSD/FreeBSD-current/ports ports
+ln -s /FreeBSD/ports ports
cd /usr/ports (this pushes into the softlink)
rm -rf distfiles (ON MASTER SERVER ONLY)
@@ -344,7 +235,7 @@
If a particular client is running -CURRENT,
.Pa /usr/src
should be a softlink to
-.Pa /FreeBSD/FreeBSD-current/src .
+.Pa /FreeBSD/src .
If it is running -STABLE,
.Pa /usr/src
should be a softlink to
@@ -359,8 +250,8 @@
(ON EACH CLIENT)
cd /usr
rm -rf ports src
-ln -s /FreeBSD/FreeBSD-current/ports ports
-ln -s /FreeBSD/FreeBSD-XXX/src src
+ln -s /FreeBSD/ports ports
+ln -s /FreeBSD/src src
.Ed
.Pp
Do not forget to create the working directories so you can build ports, as
@@ -521,11 +412,6 @@
which is typically local to the client.
You can then do builds to your heart's content!
.Sh MAINTAINING A LOCAL BRANCH
-I have described how to maintain two versions of the source tree, a stable
-version in
-.Pa /FreeBSD/FreeBSD-4.x
-and a current version in
-.Pa /FreeBSD/FreeBSD-current .
There is absolutely nothing preventing you
from breaking out other versions of the source tree
into
@@ -548,94 +434,18 @@
Many developers choose to maintain a local branch of
.Fx
to test patches or build a custom distribution.
-This can be done with CVS or another source code management system
-(SubVersion, Perforce, BitKeeper) with its own repository.
-Since the main
-.Fx
-tree is based on CVS, the former is convenient.
-.Pp
-First, you need to modify your
-.Xr csup 1
-environment to avoid it modifying
-the local changes you have committed to the repository.
-It is important to remove the
-.Ic delete
-keyword from your
-.Pa supfile
-and to add the
-.Pa CVSROOT
-subdirectory to your
-.Pa refuse
-file.
-For more information, see
-.Xr csup 1 .
-.Pp
-The
-.Fx
-version of
-.Xr cvs 1
-examines a custom environmental variable,
-.Ev CVS_LOCAL_BRANCH_NUM ,
-which specifies an integer to use when doing a
-.Xr cvs 1
-.Cm tag Ns / Ns Cm rtag .
-Set this number to something high (say 1000) to avoid colliding
-with potential future branches of the main repository.
-For example,
-branching a file with version 1.4 produces 1.4.1000.
-Future commits to this branch will produce revisions 1.4.1000.1,
-1.4.1000.2, etc.
-.Pp
-To fork your local branch, do:
-.Bd -literal -offset 4n
-cvs rtag -r RELENG_4 -b LOCAL_RELENG_4 src
-.Ed
-.Pp
-After this, you can check out a copy from your local repository using the
-new tag and begin making changes and committing them.
-For more information on using CVS, see
-.Xr cvs 1 .
-.Pp
-.Sy WARNING!
-The
-.Xr csup 1
-utility may blow away changes made on a local branch in
-some situations.
-This has been reported to occur when the master CVS repository is
-directly manipulated or an RCS file is changed.
-At this point,
-.Xr csup 1
-notices that the client and server have entirely
-different RCS files, so it does a full replace instead of trying to
-send just deltas.
-Ideally this situation should never arise, but in the real world it
-happens all the time.
-.Pp
-While this is the only scenario where the problem should crop up,
-there have been some suspicious-sounding reports of
-.Ev CVS_LOCAL_BRANCH_NUM
-lossage that cannot be explained by this alone.
-Bottom line is, if you value your local branch then you
-should back it up before every update.
-.Sh UPDATING VIA CVS
-The advantage of using
-.Xr csup 1
-to maintain an updated copy of the CVS
-repository instead of using it to maintain source trees directly is that you
-can then pick and choose when you bring your source tree (or pieces of your
-source tree) up to date.
+This can be done with svn or another source code management system
+(git, mercurial, Perforce, BitKeeper) with its own repository.
+.Sh "UPDATING VIA SVN"
By using a
.Xr cron 8
-job to maintain an updated CVS repository, you can update
-your source tree at any time without any network cost as follows:
+job to maintain an updated svn repository,
+the source tree can be
+updated at any time as follows:
.Bd -literal -offset 4n
(on the main development server)
-cd /usr/src
-cvs -d /home/ncvs update
-cd /usr/src2
-cvs -d /home/ncvs update
-cd /usr/ports
-cvs -d /home/ncvs update
+cd /usr
+svn update src doc ports
.Ed
.Pp
It is that simple, and since you are exporting the whole lot to your
@@ -642,41 +452,10 @@
clients, your clients have immediate visibility into the updated
source.
This is a good time to also remind you that most of the
-.Xr cvs 1
+.Xr svn 1
operations you do will be done as
-.Dq Li root ,
-and that certain options are
-required for CVS to operate properly on the
-.Fx
-repository.
-For example,
-.Fl Pd
-is necessary when running
-.Nm cvs Cm update .
-These options are typically placed in your
-.Pa ~/.cvsrc
-(as already described)
-so you do not have to re-specify them every time you run a
-.Xr cvs 1
-command.
-Maintaining the CVS repository also gives you far more flexibility
-in regards to breaking out multiple versions of the source tree.
-It is a good idea to give your
-.Pa /FreeBSD
-partition a lot of space (I recommend
-8-12GB) precisely for that reason.
-If you can make it 15GB I would do it.
+.Dq Li root .
.Pp
-I generally do not
-.Nm cvs Cm update
-via a
-.Xr cron 8
-job.
-This is because I generally want the source to not change out from under me
-when I am developing code.
-Instead I manually update the source every so often...\& when I feel it is
-a good time.
-My recommendation is to only keep the CVS repository synchronized via
.Xr cron 8 .
.Sh SEE ALSO
.Xr crontab 1 ,
@@ -696,3 +475,9 @@
in
.Fx 5.0 ,
December 2002.
+It was since extensively modified by
+.An Eitan Adler Aq eadler at FreeBSD.org
+to reflect the repository conversion from
+.Xr cvs
+to
+.Xr svn .
Property changes on: trunk/share/man/man7/development.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/environ.7
===================================================================
--- trunk/share/man/man7/environ.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/environ.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)environ.7 8.3 (Berkeley) 4/19/94
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/environ.7 243117 2012-11-16 01:43:23Z grog $
.\"
.Dd April 12, 2003
.Dt ENVIRON 7
@@ -56,13 +57,9 @@
.Xr du 1
and
.Xr ls 1 .
-.Ev BLOCKSIZE
-may be specified in units of a byte by specifying a number,
-in units of a kilobyte by specifying a number followed by ``K'' or
-``k'', in units of a megabyte by specifying a number followed by ``M''
-or ``m'' and in units of a gigabyte by specifying a number followed
-by ``G'' or ``g''.
-Sizes less than 512 bytes or greater than a gigabyte are ignored.
+This variable is processed by the
+.Xr getbsize 3
+function.
.It Ev COLUMNS
The user's preferred width in column positions for the terminal.
Utilities such as
@@ -259,6 +256,7 @@
.Xr execve 2 ,
.Xr execle 3 ,
.Xr getenv 3 ,
+.Xr getbsize 3 ,
.Xr setenv 3 ,
.Xr setlocale 3 ,
.Xr system 3 ,
Property changes on: trunk/share/man/man7/environ.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/ffs.7
===================================================================
--- trunk/share/man/man7/ffs.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/ffs.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001 Networks Associates Technology, Inc.
.\" All rights reserved.
.\"
@@ -28,7 +29,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/ffs.7 148337 2005-07-23 15:09:27Z markus $
.\"
.Dd December 26, 2001
.Dt FFS 7
Property changes on: trunk/share/man/man7/ffs.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/firewall.7
===================================================================
--- trunk/share/man/man7/firewall.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/firewall.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2001 Matthew Dillon. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -21,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/firewall.7 250604 2013-05-13 18:13:50Z joel $
.\"
.Dd May 26, 2001
.Dt FIREWALL 7
@@ -91,7 +92,7 @@
.Sh IPFW KERNEL CONFIGURATION
You do not need to create a custom kernel to use the IP firewalling features.
If you enable firewalling in your
-.Em /etc/rc.conf
+.Pa /etc/rc.conf
(see below), the ipfw kernel module will be loaded automatically
when necessary.
However,
@@ -103,7 +104,7 @@
If compiled in the kernel, ipfw denies all
packets by default, which means that, if you do not load in
a permissive ruleset via
-.Em /etc/rc.conf ,
+.Pa /etc/rc.conf ,
rebooting into your new kernel will take the network offline.
This can prevent you from being able to access your system if you
are not sitting at the console.
Property changes on: trunk/share/man/man7/firewall.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: trunk/share/man/man7/growfs.7
===================================================================
--- trunk/share/man/man7/growfs.7 (rev 0)
+++ trunk/share/man/man7/growfs.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -0,0 +1,65 @@
+.\" $MidnightBSD$
+.\" Copyright 2014 John-Mark Gurney
+.\" All rights reserved.
+.\"
+.\" 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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: stable/10/share/man/man7/growfs.7 284009 2015-06-05 00:46:49Z cperciva $
+.\"
+.Dd November 1, 2014
+.Dt GROWFS 7
+.Os
+.Sh NAME
+.Nm growfs
+.Nd start up script to grow the root file-system.
+.Sh DESCRIPTION
+The following options in
+.Pa /etc/rc.conf
+control the behavior of
+.Nm :
+.Bl -tag -width ".Va growfs_enable" -offset indent
+.It Va growfs_enable
+.Pq Dq Li NO
+If set to
+.Dq Li YES ,
+the first time the machine boots, the root file-system will be automatically
+expanded, if possible, to fill up all available space after it.
+.El
+.Pp
+To expand the root file-system with-out rebooting, run the following command:
+.Dl % /etc/rc.d/growfs onestart
+.Sh IMPLEMENTATION NOTES
+The script requires that
+.Pa awk
+be present and on the path.
+This usually means that
+.Pa /usr
+should be mounted prior to running the script.
+.Sh FILES
+.Pa /etc/rc.conf
+.Sh EXIT STATUS
+.Ex -std
+.Sh SEE ALSO
+.Xr rc.conf 5
+.Sh AUTHORS
+The man page and script were written by
+.An John-Mark Gurney Aq Mt jmg at FreeBSD.org .
Property changes on: trunk/share/man/man7/growfs.7
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man7/hier.7
===================================================================
--- trunk/share/man/man7/hier.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/hier.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,9 +31,9 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)hier.7 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/hier.7 317302 2017-04-22 21:57:26Z rgrimes $
.\"
-.Dd January 21, 2010
+.Dd March 13, 2017
.Dt HIER 7
.Os
.Sh NAME
@@ -52,18 +53,28 @@
.It Pa defaults/
default bootstrapping configuration files; see
.Xr loader.conf 5
+.It Pa dtb/
+Compiled flattened device tree (FDT) files; see
+.Xr fdt 4
+and
+.Xr dtc 1
+.It Pa firmware/
+Loadable modules containing binary firmware for hardware that needs
+firmware downloaded to it to function
.It Pa kernel/
pure kernel executable (the operating system loaded into memory
-at boot time).
+at boot time)
.It Pa modules/
third-party loadable kernel modules;
see
.Xr kldstat 8
+.It Pa zfs/
+Contains
+.Xr zfs 8
+zpool cache files.
.El
.It Pa /cdrom/
default mount point for CD-ROM drives
-(created by
-.Xr sysinstall 8 )
.It Pa /compat/
normally a link to
.Pa /usr/compat .
@@ -70,8 +81,6 @@
If not, then the
.Pa /usr/compat
comments apply
-(created by
-.Xr sysinstall 8 )
.It Pa /dev/
device special files managed by
.Xr devfs 5
@@ -84,9 +93,6 @@
.It Pa net/
network devices
.El
-.It Pa /dist/
-mount point used by
-.Xr sysinstall 8
.It Pa /etc/
system configuration files and scripts
.Pp
@@ -97,10 +103,6 @@
.Xr rc 8
.It Pa bluetooth/
bluetooth configuration files
-.It Pa gnats/
-gnats configuration files;
-see
-.Xr send-pr 1
.It Pa localtime
local timezone information;
see
@@ -111,10 +113,6 @@
mtree configuration files;
see
.Xr mtree 8
-.It Pa namedb/
-named configuration files;
-see
-.Xr named 8
.It Pa pam.d/
configuration files for the Pluggable Authentication Modules (PAM)
library
@@ -166,6 +164,10 @@
.It Pa /mnt/
empty directory commonly used by
system administrators as a temporary mount point
+.It Pa /net/
+automounted NFS shares;
+see
+.Xr auto_master 5
.It Pa /proc/
process file system;
see
@@ -190,8 +192,6 @@
.It Pa compat/
files needed to support binary compatibility with other operating systems,
such as Linux
-(created by
-.Xr sysinstall 8 )
.It Pa games/
useful and semi-frivolous programs
.It Pa include/
@@ -252,14 +252,8 @@
MS-DOS file system
.It Pa nfs/
C include files for NFS (Network File System) version 2, 3 and 4
-.It Pa ntfs/
-NTFS file system
.It Pa nullfs/
loopback file system
-.It Pa nwfs/
-NetWare file system
-.It Pa portalfs/
-portal file system
.It Pa procfs/
process file system
.It Pa smbfs/
@@ -398,10 +392,15 @@
.It Pa aout/
a.out backward compatibility libraries
.El
+.It Pa debug/
+standalone debug data for the base system libraries and binaries
.It Pa dtrace/
DTrace library scripts
.It Pa engines/
OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
+.It Pa private/
+Private system libraries not for use by third-party programs.
+ABI and API stability are not guaranteed.
.El
.Pp
.It Pa libdata/
@@ -449,15 +448,31 @@
Also used as the default destination for the
.Fx
ports framework.
-Within local/, the general layout sketched out by
+Within
+.Pa local/ ,
+the general layout sketched out by
.Nm
-for /usr
+for
+.Pa /usr
should be used.
-Exceptions are the man directory (directly under local/
-rather than under local/share/), ports documentation (in share/doc/<port>/),
-and /usr/local/etc (mimics /etc).
+Exceptions are the
+.Pa man
+directory
+.Po directly under
+.Pa local/
+rather than under
+.Pa local/share/ Ns Pc ,
+ports documentation
+.Po in
+.Pa share/doc/<port>/ Ns Pc ,
+and
+.Pa /usr/local/etc
+.Po mimics
+.Pa /etc Ns Pc .
.It Pa obj/
-architecture-specific target tree produced by building the /usr/src tree
+architecture-specific target tree produced by building the
+.Pa /usr/src
+tree
.It Pa ports/
The
.Fx
@@ -546,6 +561,16 @@
device description file for device name
.It Pa info/
GNU Info hypertext system
+.It Pa keys/
+known trusted and revoked keys.
+.Bl -tag -width ".Pa keys/pkg/" -compact
+.It Pa keys/pkg/
+fingerprints for
+.Xr pkg 7
+and
+.Xr pkg 8
+.El
+.Pp
.It Pa locale/
localization files;
see
@@ -552,6 +577,8 @@
.Xr setlocale 3
.It Pa man/
manual pages
+.It Pa mdocml/
+data files used by mdocml
.It Pa me/
macros for use with the me macro package;
see
@@ -627,6 +654,26 @@
.It Pa vi/
localization support and utilities for
.Xr vi 1
+.It Pa vt/
+files used by vt;
+see
+.Xr vt 4
+.Bl -tag -width ".Pa scrnmaps/" -compact
+.It Pa fonts/
+console fonts;
+see
+.Xr vidcontrol 1
+and
+.Xr vidfont 1
+.It Pa keymaps/
+console keyboard maps;
+see
+.Xr kbdcontrol 1
+and
+.Xr kbdmap 1
+.\" .It Pa scrnmaps/
+.\" console screen maps
+.El
.It Pa zoneinfo/
timezone configuration information;
see
@@ -639,44 +686,72 @@
.Bl -tag -width ".Pa kerberos5/" -compact
.It Pa bin/
source code for files in /bin
+.It Pa cddl/
+Utilities covered by the Common Development and Distribution License
.It Pa contrib/
source code for contributed software
.It Pa crypto/
source code for contributed cryptography software
.It Pa etc/
-source code for files in /etc
+source code for files in
+.Pa /etc
.It Pa games/
-source code for files in /usr/games
+source code for files in
+.Pa /usr/games
.It Pa gnu/
Utilities covered by the GNU General Public License
.It Pa include/
-source code for files in /usr/include
+source code for files in
+.Pa /usr/include
.It Pa kerberos5/
build infrastructure for kerberos version 5
.It Pa lib/
-source code for files in /usr/lib
+source code for files in
+.Pa /usr/lib
.It Pa libexec/
-source code for files in /usr/libexec
+source code for files in
+.Pa /usr/libexec
.It Pa release/
files required to produce a
.Fx
release
+.It Pa rescue/
+source code for files in
+.Pa /rescue
.It Pa sbin/
-source code for files in /sbin
+source code for files in
+.Pa /sbin
.It Pa secure/
-build directory for files in /usr/src/crypto
+build directory for files in
+.Pa /usr/src/crypto
.It Pa share/
-source for files in /usr/share
+source for files in
+.Pa /usr/share
.It Pa sys/
kernel source code
+.It Pa targets/
+support for experimental DIRDEPS_BUILD
+.It Pa tests/
+source code for files in
+.Pa /usr/tests
.It Pa tools/
tools used for maintenance and testing of
.Fx
.It Pa usr.bin/
-source code for files in /usr/bin
+source code for files in
+.Pa /usr/bin
.It Pa usr.sbin/
-source code for files in /usr/sbin
+source code for files in
+.Pa /usr/sbin
.El
+.Pp
+.It Pa tests/
+The
+.Fx
+test suite.
+See
+.Xr tests 7
+for more details.
.El
.It Pa /var/
multi-purpose log, temporary, transient, and spool files
@@ -705,6 +780,14 @@
.Pp
.It Pa backups/
miscellaneous backup files
+.It Pa cache/
+miscellaneous cached files
+.Bl -tag -width ".Pa pkg/" -compact
+.It Pa pkg/
+cached packages for
+.Xr pkg 8
+.El
+.Pp
.It Pa crash/
default directory to store kernel crash dumps; see
.Xr crash 8
@@ -765,11 +848,6 @@
system since it was booted
.Pp
.Bl -tag -width Fl -compact
-.It Pa named/
-writable by the
-.Dq bind
-user; see
-.Xr named 8
.It Pa ppp/
writable by the
.Dq network
Property changes on: trunk/share/man/man7/hier.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/hostname.7
===================================================================
--- trunk/share/man/man7/hostname.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/hostname.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1987, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,9 +31,9 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)hostname.7 8.2 (Berkeley) 12/30/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/hostname.7 260084 2013-12-30 13:05:19Z pluknet $
.\"
-.Dd December 30, 1993
+.Dd December 25, 2013
.Dt HOSTNAME 7
.Os
.Sh NAME
@@ -86,8 +87,7 @@
.Sh SEE ALSO
.Xr gethostbyname 3 ,
.Xr resolver 5 ,
-.Xr mailaddr 7 ,
-.Xr named 8
+.Xr mailaddr 7
.Sh HISTORY
.Nm Hostname
appeared in
Property changes on: trunk/share/man/man7/hostname.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/intro.7
===================================================================
--- trunk/share/man/man7/intro.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/intro.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)intro.7 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/intro.7 79538 2001-07-10 15:31:11Z ru $
.\"
.Dd June 5, 1993
.Dt INTRO 7
Property changes on: trunk/share/man/man7/intro.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/maclabel.7
===================================================================
--- trunk/share/man/man7/maclabel.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/maclabel.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2002 Networks Associates Technology, Inc.
.\" All rights reserved.
.\"
@@ -31,7 +32,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/maclabel.7 206622 2010-04-14 19:08:06Z uqs $
.\"
.Dd October 25, 2002
.Dt MACLABEL 7
Property changes on: trunk/share/man/man7/maclabel.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/mailaddr.7
===================================================================
--- trunk/share/man/man7/mailaddr.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/mailaddr.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1987, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)mailaddr.7 8.1 (Berkeley) 6/16/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/mailaddr.7 233422 2012-03-24 13:37:57Z joel $
.\"
.Dd June 16, 1993
.Dt MAILADDR 7
@@ -66,7 +67,6 @@
without adding the ``berkeley.edu'' since it is the same on both sending
and receiving hosts.
.Ss Compatibility.
-.Pp
Certain old address formats are converted to the new format to provide
compatibility with the previous mail system.
In particular,
@@ -94,9 +94,7 @@
.Pp
This is normally converted back to the ``host!user'' form before being sent
on for compatibility with older UUCP hosts.
-.Pp
.Ss Case Distinctions.
-.Pp
Domain names (i.e., anything after the ``@'' sign) may be given in any mixture
of upper and lower case with the exception of UUCP hostnames.
Most hosts
@@ -103,7 +101,6 @@
accept any combination of case in user names, with the notable exception of
MULTICS sites.
.Ss Route-addrs.
-.Pp
Under some circumstances it may be necessary to route a message through
several hosts to get it to the final destination.
Normally this routing
@@ -134,11 +131,9 @@
.Pp
is routed as indicated in the previous example.
.Ss Postmaster.
-.Pp
Every site is required to have a user or user alias designated ``postmaster''
to which problems with the mail system may be addressed.
.Ss Other Networks.
-.Pp
Some other networks can be reached by giving the name of the network as the
last component of the domain.
.Em This is not a standard feature
Property changes on: trunk/share/man/man7/mailaddr.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/mports.7
===================================================================
--- trunk/share/man/man7/mports.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/mports.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -24,7 +24,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man7/ports.7,v 1.50.2.2 2005/08/10 20:43:27 jcamou Exp $
-.\" $MidnightBSD: src/share/man/man7/ports.7,v 1.2 2006/10/31 19:20:02 laffer1 Exp $
+.\" $MidnightBSD$
.\"
.Dd April 15, 2009
.Dt MPORTS 7
Property changes on: trunk/share/man/man7/mports.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/operator.7
===================================================================
--- trunk/share/man/man7/operator.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/operator.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)operator.7 8.1 (Berkeley) 6/9/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/operator.7 233510 2012-03-26 15:18:14Z joel $
.\"
.Dd April 8, 2009
.Dt OPERATOR 7
@@ -45,7 +46,7 @@
.It "-------- -------------"
.It "() [] -> . left to right"
.It "! ~ ++ -- - (type) * & sizeof new delete right to left"
-.It "->* .* left to right
+.It "->* .* left to right"
.It "* / % left to right"
.It "+ - left to right"
.It "<< >> left to right"
Property changes on: trunk/share/man/man7/operator.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/release.7
===================================================================
--- trunk/share/man/man7/release.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/release.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2002 Murray Stokely <murray at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/release.7 331835 2018-03-31 01:37:14Z gjb $
.\"
-.Dd January 31, 2013
+.Dd March 28, 2018
.Dt RELEASE 7
.Os
.Sh NAME
@@ -49,9 +50,10 @@
For some users, it may be desirable to provide an absolutely clean
build environment, with no local modifications to the source tree or to
.Xr make.conf 5 ,
-and with clean checkouts of specific versions of the doc, src, and mports
-trees. For this purpose, a script
-.Pq Pa src/release/generate-release.sh
+and with clean checkouts of specific versions of the doc, src, and ports
+trees.
+For this purpose, a script
+.Pq Pa src/release/release.sh
is provided to automate these checkouts and then execute
.Dq Li "make release"
in a clean
@@ -70,71 +72,384 @@
.Dq Li "make buildkernel" .
This is necessary to provide the object files for the release or, when
using
-.Pa generate-release.sh ,
+.Pa release.sh ,
so that the object files for a complete system can be installed into a clean
.Xr chroot 8
-environment. In this second case, the built world must be capable of running
-on the build system (i.e. it must be for the same architecture and be
-compatible with the installed kernel).
+environment.
+.Pp
+If the target release build is for a different architecture or machine type,
+the
+.Va TARGET
+and
+.Va TARGET_ARCH
+variables must be used.
+See the supported
+.Fa release.conf
+variables for more information.
+.Pp
The release procedure on some architectures may also require that the
.Xr md 4
(memory disk) device driver be present in the kernel
-(either by being compiled in or available as a module).
+.Pq either by being compiled in or available as a module .
.Pp
This document does not cover source code management, quality
assurance, or other aspects of the release engineering process.
.Sh CLEAN RELEASE GENERATION
-Official releases of MidnightBSD are produced in a totally clean environment to
-ensure consistency between the versions of the src, mports, and doc trees
-and to avoid contamination from the host system (e.g. local patches, changes
+Official releases of
+.Fx
+are produced in a totally clean environment to
+ensure consistency between the versions of the src, ports, and doc trees
+and to avoid contamination from the host system
+.Po such as local patches, changes
to
.Xr make.conf 5 ,
-etc.). This is accomplished using the wrapper script
-.Pa src/release/generate-release.sh .
+etc.
+.Pc .
+This is accomplished using the wrapper script
+.Pa src/release/release.sh .
.Pp
-.Ic generate-release.sh
-svn-branch scratch-dir
+.Ic release.sh
+.Op Fl c Ar release.conf
.Pp
-.Ic generate-release.sh
-calls
+.Ic release.sh
+checks out the
+.Li src/ ,
+.Li ports/ ,
+and
+.Li doc/
+trees to
+.Va CHROOTDIR ,
+then calls
+.Dq Li "make buildworld"
+and
.Dq Li "make installworld"
to generate a
.Xr chroot 8
-environment in
-.Ar scratch-dir .
-It then checks out the src tree specified by
-.Ar svn-branch
-using
-.Xr svn 1 .
-Once the various source trees have been obtained, it executes
+environment.
+Next,
.Dq Li "make release"
-within the
+is run within the
.Xr chroot 8
environment and places the result in
-.Pa $scratch-dir/R .
-Note that because this uses a chroot, it cannot be used to cross-build
-.Fx
-release media.
+.Pa $CHROOTDIR/R .
.Pp
-Environment variables:
-.Bl -tag -width ".Cm MAKE_FLAGS"
-.It Ev MAKE_FLAGS
-This environment variable can be set to pass flags (e.g. -j) to
+The optional
+.Fa release.conf
+configuration file supports the following variables:
+.Bl -tag -width Ev
+.It Va CHROOTDIR
+The directory within which the release will be built.
+.It Va CHROOT_MAKEENV
+Additional
.Xr make 1
-when invoked by the script.
-.It Ev SVNROOT
-The location of the MidnightBSD SVN source and mports repositories.
+arguments to pass through, which directly affect the
+tuning of the build chroot.
+.It Va SVNROOT
+The
+.Xr svn 1
+host used to check out the various trees.
Defaults to
-.Pa svn://svn.midnightbsd.org/svn/src
-for the source tree,
-.Pa svn://svn.midnightbsd.org/svn/mports/trunk
-for the Ports Tree source.
-.It Ev RELSTRING
-Optional base name for generated media images (e.g. MidnightBSD-0.9-amd64).
-Defaults to the output of
-.Ic `uname -s`-`uname -r`-`uname -p`
-within the chroot.
+.Pa svn://svn.FreeeBSD.org .
+.It Va SRCBRANCH
+The
+.Li src/
+branch to use.
+Defaults to
+.Va head/@rHEAD .
+.It Va DOCBRANCH
+The
+.Li doc/
+branch to use.
+Defaults to
+.Va head/@rHEAD .
+.It Va PORTBRANCH
+The
+.Li ports/
+branch to use.
+Defaults to
+.Va head/@rHEAD .
+.It Va TARGET
+The target machine type for cross-building a release.
+.It Va TARGET_ARCH
+The target machine architecture for cross-building a release.
+.Pp
+For the supported list of
+.Va TARGET
+and
+.Va TARGET_ARCH
+combinations, consult the output of
+.Dq make targets
+as documented in
+.Xr build 7 .
+.It Va KERNEL
+The target kernel configuration to use.
+Defaults to
+.Va GENERIC .
+Multiple
+.Va KERNEL
+entries may be specified.
+.It Va MAKE_CONF
+The
+.Xr make.conf 5
+to use for the release build.
+Defaults to
+.Fa /dev/null
+to prevent polluting the release with local system changes.
+.It Va SRC_CONF
+The
+.Xr src.conf 5
+to use for the release build.
+Defaults to
+.Fa /dev/null
+to prevent polluting the release with local system changes.
+.It Va MAKE_FLAGS
+Additional flags to pass to
+.Xr make 1 .
+.It Va WORLD_FLAGS
+Additional flags to pass to
+.Xr make 1
+during the
+.Dq buildworld
+phase.
+Defaults to setting the number of
+.Xr make 1
+jobs
+.Pq Ar -j
+to the number of CPUs available on a SMP-capable system.
+.It Va KERNEL_FLAGS
+Additional flags to pass to
+.Xr make 1
+during the
+.Dq buildkernel
+phase.
+Defaults to setting the number of
+.Xr make 1
+jobs
+.Pq Ar -j
+to half the number of CPUs available on a SMP-capable system.
+.It Va NODOC
+Set to a non-empty value to skip the
+.Li doc/
+tree checkout.
+When set,
+.Va NODOC
+will prevent the
+.Fa doc.txz
+distribution package from being created.
+.It Va NOPORTS
+Set to a non-empty value to skip the
+.Li ports/
+tree checkout.
+When set,
+.Va NOPORTS
+will prevent the
+.Fa ports.txz
+distribution package from being created.
+Setting this also sets
+.Va NODOC .
+.It Va WITH_DVD
+Set to a non-empty value to include the
+.Cm dvdrom
+target.
+.It Va WITH_COMPRESSED_IMAGES
+Set to a non-empty value to compress the release images with
+.Xr xz 1 .
+The original
+.Pq uncompressed
+images are not removed.
+.It Va VCSCMD
+The command run to obtain the source trees.
+Defaults to
+.Qq Cm svn checkout .
+.It Va CHROOTBUILD_SKIP
+If defined, the
+.Li buildworld ,
+.Li installworld ,
+and
+.Li distribution
+stages of the
+.Xr chroot 8
+build environment setup are skipped.
+This is intended solely for cases where the
+.Xr chroot 8
+userland are provided by alternate means.
+.It Va SRC_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/src
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/src
+is expected to exist by alternative means.
+.It Va DOC_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/doc
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/doc
+is expected to exist by alternative means.
+.It Va PORTS_UPDATE_SKIP
+Set to a non-empty value to prevent checkout or update of
+.Fa /usr/ports
+within the
+.Xr chroot 8 .
+This is intended for use only when
+.Fa /usr/ports
+is expected to exist by alternative means.
.El
+.Sh EMBEDDED BUILDS
+The following
+.Fa release.conf
+variables are relevant only to release builds for embedded systems:
+.Bl -tag -width Ev
+.It Va EMBEDDEDBUILD
+Set to a non-null value to enable functionality for embedded device
+release builds.
+.Pp
+When set,
+.Va WITH_DVD
+is unset, and
+.Va NODOC
+is defined.
+Additionally,
+.Va EMBEDDED_TARGET
+and
+.Va EMBEDDED_TARGET_ARCH
+must also be defined.
+When the build environment is created,
+.Fa release.sh
+runs a separate build script located in an architecture-specific
+directory in
+.Pa src/release/${EMBEDDED_TARGET}/ .
+.It Va EMBEDDEDPORTS
+Set to the list of any ports that are required for the target device
+in the format of
+.Fa category/port .
+The
+.Fa devel/subversion
+port is built by default.
+.It Va EMBEDDED_TARGET
+When set, its value is passed to
+.Xr make 1
+to set the
+.Va TARGET
+.Pq value of Cm uname Fl m
+to cross build the target userland.
+.It Va EMBEDDED_TARGET_ARCH
+When set, its value is passed to
+.Xr make 1
+to set the
+.Va TARGET_ARCH
+.Pq value of Cm uname Fl p
+to cross build the target userland.
+.El
+.Sh VIRTUAL MACHINE DISK IMAGES
+The following
+.Fa release.conf
+variables are relevant only to virtual machine disk image builds:
+.Bl -tag -width Ev
+.It Va WITH_VMIMAGES
+Set to a non-null value to build virtual machine disk images as part
+of the release build.
+.Va WITH_VMIMAGES
+may also be specified as an envirionment variable passed to
+.Xr make 1 .
+.Pp
+The option requires
+.Xr mkimg 1
+version 20140927 or later.
+.It Va WITH_COMPRESSED_VMIMAGES
+Set to a non-null value to compress the virtual machine disk images with
+.Xr xz 1
+as part of the
+.Cm install
+.Xr make 1
+target.
+Note that compressing virtual machine disk images may take a very long
+time on some systems.
+.It Va VMBASE
+Set to change the name of the resulting virtual machine disk image file.
+The default value is
+.Va vm .
+.It Va VMSIZE
+Set to change the size of the virtual machine disk capacity.
+The default value is
+.Va 20G .
+See
+.Xr truncate 1
+for valid values.
+.Pp
+Virtual machine disk images are, by default, created as sparse images.
+When
+.Va WITH_COMPRESSED_VMIMAGES
+is used, the resulting files compressed with
+.Xr xz 1
+compress to roughly the same size, regardless of the specified disk image
+size.
+.It Va VMFORMATS
+Set to the target virtual disk image format(s) to create.
+By default, the
+.Va vhdf , Va vmdk , Va qcow2 ,
+and
+.Va raw
+formats are created.
+See
+.Xr mkimg 1
+for valid format values
+.Pq requires version 20140927 or later .
+.El
+.Pp
+For a list of supported
+.Va VMFORMATS
+values
+.Pq including cloud hosting provider formats
+along with a brief description, run:
+.Bd -literal -offset indent
+cd /usr/src
+make -C release list-vmtargets
+.Ed
+.Sh CLOUD HOSTING MACHINE IMAGES
+The
+.Fx
+release build tools support building virtual machine images for various
+cloud hosting providers, each with their own specific configuration to
+include support for each hosting provider by default.
+.Pp
+The following
+.Xr make 1
+environment variables are supported:
+.Pp
+.Bl -tag -width Ev
+.It Va CLOUDWARE
+Set to a list of one or more cloud hosting providers, enclosed in quotes.
+Requires
+.Va WITH_CLOUDWARE
+to also be set.
+.It Va WITH_CLOUDWARE
+Set to a non-empty value to enable building virtual machine images
+for various cloud hosting providers.
+Requires
+.Va CLOUDWARE
+to also be set.
+.El
+.Pp
+Additionally, the
+.Va CLOUDWARE
+and
+.Va WITH_CLOUDWARE
+variables can be added to
+.Pa release.conf ,
+and used in conjunction with
+.Pa release.sh .
+.Pp
+For a list of supported
+.Va CLOUDWARE
+values, run:
+.Bd -literal -offset indent
+cd /usr/src
+make -C release list-cloudware
+.Ed
.Sh MAKEFILE TARGETS
The release makefile
.Pq Pa src/release/Makefile
@@ -153,44 +468,84 @@
Copy all produced release media to
.Pa ${DESTDIR} .
.It Cm cdrom
-Builds installation CD-ROM images. On some systems, this may require that
-.Xr mkisofs 8
-be installed
-.Pq Pa sysutils/cdrtools
-and possibly that the
+Builds installation CD-ROM images.
+This may require the
.Xr md 4
(memory disk) device driver be present in the kernel
-(either by being compiled in or available as a module). This target
-produces files called
-.Pa release.iso
+(either by being compiled in or available as a module).
+This target produces files called
+.Pa disc1.iso
and
.Pa bootonly.iso
as its output.
+.It Cm dvdrom
+Builds installation DVD-ROM images.
+This may require the
+.Xr md 4
+(memory disk) device driver be present in the kernel
+(either by being compiled in or available as a module).
+This target produces the
+.Pa dvd1.iso
+file as its output.
.It Cm memstick
Builds an installation memory stick image named
-.Pa memstick .
-Not applicable on all platforms. Requires that the
+.Pa memstick.img .
+Not applicable on all platforms.
+Requires that the
.Xr md 4
-(memory disk) device driver be present in the kernel
-(either by being compiled in or available as a module).
+.Pq memory disk
+device driver be present in the kernel
+.Pq either by being compiled in or available as a module .
+.It Cm mini-memstick
+Similar to
+.Cm memstick ,
+with the exception that the installation distribution sets
+are not included.
.It Cm ftp
Creates a directory named
.Pa ftp
containing the distribution files used in network installations
and suitable for upload to an FTP mirror.
+.It Cm vm-image
+Creates virtual machine disk images in various formats.
+The
+.Cm vm-image
+target requires the
+.Va WITH_VMIMAGES
+.Xr make 1
+envirionment variable to be set to a non-null value.
+.It Cm vm-cloudware
+Builds
+.Fx
+virtual machine images for various cloud hosting providers.
+See
+.Qq CLOUD HOSTING MACHINE IMAGES
+for implementation details.
+.It Cm list-cloudware
+Displays the list of valid
+.Va CLOUDWARE
+values.
+.It Cm list-vmtargets
+Displays the list of valid
+.Va VMFORMAT
+and
+.Va CLOUDWARE
+values.
.El
.Pp
Major subtargets called by targets above:
.Bl -tag -width ".Cm packagesystem"
.It Cm packagesystem
-Generates all the distribution archives (e.g. base, kernel, mports, doc)
+Generates all the distribution archives
+.Pq base, kernel, ports, doc
applicable on this platform.
-.It Cm system
+.It Cm disc1
Builds a bootable installation system containing all the distribution files
packaged by the
.Cm packagesystem
target, and suitable for imaging by the
-.Cm cdrom
+.Cm cdrom ,
+.Cm dvdrom
and
.Cm memstick
targets.
@@ -197,35 +552,45 @@
.It Cm reldoc
Builds the release documentation.
This includes the release notes,
-hardware guide, and installation instructions. Other documentation (e.g.
-the Handbook) is built during the
+hardware guide, and installation instructions.
+Other documentation, such as the Handbook,
+is built during the
.Cm base.txz
target invoked by
-.Cm packagesystem.
+.Cm packagesystem .
.El
.Sh ENVIRONMENT
Optional variables:
-.Bl -tag -width ".Va TARGET_ARCH"
-.It Va WORLDDIR
-Location of a directory containing the src tree. By default, the directory
+.Bl -tag -width ".Ev TARGET_ARCH"
+.It Ev OSRELEASE
+Optional base name for generated media images
+.Pq e.g., FreeBSD-9.0-RC2-amd64 .
+Defaults to the output of
+.Ic `uname -s`-`uname -r`-`uname -p`
+within the chroot.
+.It Ev WORLDDIR
+Location of a directory containing the src tree.
+By default, the directory
above the one containing the makefile
.Pq Pa src .
-.It Va PORTSDIR
-Location of a directory containing the mports tree. By default,
-.Pa /usr/mports .
-If it is unset or cannot be found, mports will not be included in the release.
-.It Va DOCDIR
-Location of a directory containing the doc tree. By default,
+.It Ev PORTSDIR
+Location of a directory containing the ports tree.
+By default,
+.Pa /usr/ports .
+If it is unset or cannot be found, ports will not be included in the release.
+.It Ev DOCDIR
+Location of a directory containing the doc tree.
+By default,
.Pa /usr/doc .
If it is unset or cannot be found, most documentation will not be included in
the release; see
.Ev NODOC
below.
-.It Va NOPORTS
+.It Ev NOPORTS
If defined, the Ports Collection will be omitted from the release.
-.It Va NOSRC
+.It Ev NOSRC
If set, do not include system source code in the release.
-.It Va NODOC
+.It Ev NODOC
If defined, the XML-based documentation from the
.Fx
Documentation Project will not be built.
@@ -234,7 +599,7 @@
distribution will still be created with the minimal documentation set
provided in
.Pa src/share/doc .
-.It Va TARGET
+.It Ev TARGET
The target hardware platform.
This is analogous to the
.Dq Nm uname Fl m
@@ -241,13 +606,13 @@
output.
This is necessary to cross-build some target architectures.
For example, cross-building for PC98 machines requires
-.Va TARGET_ARCH Ns = Ns Li i386
+.Ev TARGET_ARCH Ns = Ns Li i386
and
-.Va TARGET Ns = Ns Li pc98 .
+.Ev TARGET Ns = Ns Li pc98 .
If not set,
-.Va TARGET
+.Ev TARGET
defaults to the current hardware platform.
-.It Va TARGET_ARCH
+.It Ev TARGET_ARCH
The target machine processor architecture.
This is analogous to the
.Dq Nm uname Fl p
@@ -254,25 +619,29 @@
output.
Set this to cross-build for a different architecture.
If not set,
-.Va TARGET_ARCH
+.Ev TARGET_ARCH
defaults to the current machine architecture, unless
-.Va TARGET
+.Ev TARGET
is also set, in which case it defaults to the appropriate
value for that platform.
Typically, one only needs to set
-.Va TARGET .
+.Ev TARGET .
.El
.Sh FILES
-.Bl -tag -compact
+.Bl -tag -compact -width Pa
.It Pa /usr/doc/Makefile
.It Pa /usr/doc/share/mk/doc.project.mk
-.It Pa /usr/mports/Mk/bsd.port.mk
-.It Pa /usr/mports/Mk/components/sites.mk
+.It Pa /usr/ports/Mk/bsd.port.mk
+.It Pa /usr/ports/Mk/bsd.sites.mk
.It Pa /usr/share/examples/etc/make.conf
.It Pa /usr/src/Makefile
.It Pa /usr/src/Makefile.inc1
.It Pa /usr/src/release/Makefile
-.It Pa /usr/src/release/generate-release.sh
+.It Pa /usr/src/release/Makefile.vm
+.It Pa /usr/src/release/release.sh
+.It Pa /usr/src/release/release.conf.sample
+.It Pa /usr/src/release/tools/*.conf
+.It Pa /usr/src/release/tools/vmimage.subr
.El
.Sh EXAMPLES
The following sequence of commands can be used to build a
@@ -279,17 +648,17 @@
.Dq "-CURRENT snapshot":
.Bd -literal -offset indent
cd /usr
-svn co svn://svn.midnightbsd.org/svn/src/trunk src
+svn co svn://svn.freebsd.org/base/head src
cd src
make buildworld buildkernel
cd release
make release
-make install DESTDIR=/var/midnightbsd-snapshot
+make install DESTDIR=/var/freebsd-snapshot
.Ed
.Pp
After running these commands, all produced distribution files (tarballs
for FTP, CD-ROM images, etc.) are available in the
-.Pa /var/midnightbsd-snapshot
+.Pa /var/freebsd-snapshot
directory.
.Pp
The following sequence of commands can be used to build a
@@ -297,18 +666,49 @@
in a clean environment, including ports and documentation:
.Bd -literal -offset indent
cd /usr/src/release
-export SVNROOT=svn://svn.midnightbsd.org/svn/src/
-sh generate-release.sh head /local3/release
+sh release.sh
.Ed
.Pp
+Optionally, a configuration file can be used customize the release build,
+such as the subversion revision to use, the branch of the subversion tree for
+.Li src/ ,
+.Li ports/ ,
+and
+.Li doc/ .
+.Bd -literal -offset indent
+cd /usr/src/release
+sh release.sh -c $HOME/release.conf
+.Ed
+.Pp
+Configuration files specific to various supported embedded systems, such as
+the Raspberry Pi, exist in the directory corresponding to the
+.Va TARGET
+.Xr make 1
+variable.
+For example, to build an image for the Raspberry Pi:
+.Bd -literal -offset indent
+cd /usr/src/release
+sh release.sh -c arm/RPI-B.conf
+.Ed
+.Pp
+To build an image for the Raspberry Pi 3:
+.Bd -literal -offset indent
+cd /usr/src/release
+sh release.sh -c arm64/RPI3.conf
+.Ed
+.Pp
After running these commands, all prepared release files are available in the
-.Pa /local3/release/R
+.Pa /scratch
directory.
+The target directory can be changed by specifying the
+.Va CHROOTDIR
+variable in
+.Li release.conf .
.Sh SEE ALSO
.Xr cc 1 ,
.Xr install 1 ,
.Xr make 1 ,
-.Xr svn 1 Pq Pa mports/devel/subversion ,
+.Xr svn 1 Pq Pa ports/devel/subversion ,
.Xr uname 1 ,
.Xr md 4 ,
.Xr make.conf 5 ,
@@ -317,6 +717,18 @@
.Xr chroot 8 ,
.Xr mtree 8 ,
.Xr sysctl 8
+.Rs
+.%T "FreeBSD Release Engineering"
+.%U https://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/freebsd-releng/
+.Re
+.Rs
+.%T "FreeBSD Release Engineering of Third Party Packages"
+.%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/
+.Re
+.Rs
+.%T "FreeBSD Developers' Handbook"
+.%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
+.Re
.Sh HISTORY
.Fx
1.x
@@ -342,6 +754,16 @@
.Pa src/release/generate-release.sh
introduced to support the introduction of a new installer.
.Pp
+For the
+.Fx 9.2
+release,
+.Pa src/release/release.sh
+was introduced to support per-build configuration files.
+.Pa src/release/release.sh
+is heavily based on the
+.Pa src/release/generate-release.sh
+script.
+.Pp
At near 1000 revisions spread over multiple branches, the
.Xr svn 1
log of
@@ -356,5 +778,22 @@
.An Jordan Hubbard ,
and
.An Poul-Henning Kamp .
-This manual page was written by
+.Pp
+This manual page was originally written by
.An Murray Stokely Aq murray at FreeBSD.org .
+.Pp
+It was updated by
+.An Nathan Whitehorn Aq nwhitehorn at FreeBSD.org
+to include the
+.Fa generate-release.sh
+script used for the
+.Fx 9.0
+release cycle.
+.Pp
+It was later updated by
+.An Glen Barber Aq gjb at FreeBSD.org
+to include the
+.Fa release.sh
+script used for the
+.Fx 9.2
+release cycle.
Property changes on: trunk/share/man/man7/release.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/sdoc.7
===================================================================
--- trunk/share/man/man7/sdoc.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/sdoc.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001, 2002 Networks Associates Technology, Inc.
.\" All rights reserved.
.\"
@@ -25,8 +26,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: sdoc.7,v 1.3 2012-12-29 17:34:01 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: sec-doc.7,v 1.7 2001/12/22 00:14:12 rwatson Exp$
+.\" $FreeBSD: stable/10/share/man/man7/sdoc.7 213573 2010-10-08 12:40:16Z uqs $
.\"
.Dd September 5, 2005
.Dt SDOC 7
Property changes on: trunk/share/man/man7/sdoc.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/security.7
===================================================================
--- trunk/share/man/man7/security.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/security.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 1998 Matthew Dillon. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -21,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/security.7 260084 2013-12-30 13:05:19Z pluknet $
.\"
-.Dd February 8, 2012
+.Dd December 25, 2013
.Dt SECURITY 7
.Os
.Sh NAME
@@ -350,13 +351,6 @@
and
.Xr fingerd 8
in a sandbox.
-Another program which may be a candidate for running in a sandbox is
-.Xr named 8 .
-The default
-.Pa rc.conf
-includes the arguments necessary to run
-.Xr named 8
-in a sandbox in a commented-out form.
Depending on whether you
are installing a new system or upgrading an existing system, the special
user accounts used by these sandboxes may not be installed.
@@ -544,6 +538,12 @@
kernel modules (see
.Xr kld 4 )
may not be loaded or unloaded.
+The kernel debugger may not be entered using the
+.Va debug.kdb.enter
+sysctl.
+A panic or trap cannot be forced using the
+.Va debug.kdb.panic
+and other sysctl's.
.It Ic 2
Highly secure mode \- same as secure mode, plus disks may not be
opened for writing (except by
@@ -819,8 +819,6 @@
This
way you can firewall off all of your low ports except for certain specific
services such as
-.Xr named 8
-(if you are primary for a zone),
.Xr talkd 8 ,
.Xr sendmail 8 ,
and other internet-accessible services.
Property changes on: trunk/share/man/man7/security.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/sprog.7
===================================================================
--- trunk/share/man/man7/sprog.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/sprog.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001 Eric Melville <eric at FreeBSD.org>
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/sprog.7 77704 2001-06-04 15:32:44Z eric $
.\"
.Dd June 3, 2001
.Dt SPROG 7
Property changes on: trunk/share/man/man7/sprog.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/stdint.7
===================================================================
--- trunk/share/man/man7/stdint.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/stdint.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2002 Mike Barcroft <mike at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/stdint.7 119893 2003-09-08 19:57:22Z ru $
.\"
.Dd September 15, 2002
.Dt STDINT 7
Property changes on: trunk/share/man/man7/stdint.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Modified: trunk/share/man/man7/sticky.7
===================================================================
--- trunk/share/man/man7/sticky.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/sticky.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)sticky.8 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/sticky.7 218998 2011-02-24 13:03:47Z remko $
.\"
.Dd June 5, 1993
.Dt STICKY 7
Property changes on: trunk/share/man/man7/sticky.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: trunk/share/man/man7/tests.7
===================================================================
--- trunk/share/man/man7/tests.7 (rev 0)
+++ trunk/share/man/man7/tests.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -0,0 +1,241 @@
+.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/tests.7 316236 2017-03-30 05:57:01Z ngie $
+.\" $NetBSD: tests.kyua.7,v 1.2 2013/07/20 21:39:59 wiz Exp $
+.\"
+.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" 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 NETBSD FOUNDATION, INC. AND
+.\" CONTRIBUTORS ``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 FOUNDATION OR CONTRIBUTORS 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.
+.\"
+.Dd March 22, 2017
+.Dt TESTS 7
+.Os
+.Sh NAME
+.Nm tests
+.Nd introduction to the
+.Fx
+Test Suite
+.Sh DESCRIPTION
+The
+.Fx
+Test Suite provides a collection of automated tests for two major purposes.
+On one hand, the test suite aids
+.Em developers
+to detect bugs and regressions when they modify the source tree.
+On the other hand, it allows
+.Em end users
+(and, in particular, system administrators) to verify that fresh installations
+of the
+.Fx
+operating system behave correctly on their hardware platform and also to ensure
+that the system does not suffer from regressions during regular operation and
+maintenance.
+.Pp
+The
+.Fx
+Test Suite can be found in the
+.Pa /usr/tests
+hierarchy.
+.Pp
+This manual page describes how to run the test suite and how to configure
+some of its optional features.
+.Ss Installing the test suite
+The test suite is not yet installed by default as part of
+.Fx ,
+but this is bound to change during the development of
+.Fx 11.0 .
+.Pp
+If the
+.Pa /usr/tests
+directory is missing, then you will have to enable the build of the test
+suite, rebuild your system and install the results.
+You can do so by setting
+.Sq WITH_TESTS=yes
+in your
+.Pa /etc/src.conf
+file (see
+.Xr src.conf 5
+for details)
+and rebuilding the system as described in
+.Xr build 7 .
+.Ss When to run the tests?
+Before diving into the details of how to run the test suite, here are some
+scenarios in which you should run it:
+.Bl -bullet -offset indent
+.It
+After a fresh installation of
+.Fx
+to ensure that the system works correctly on your hardware platform.
+.It
+After an upgrade of
+.Fx
+to a different version to ensure that the new code works well on your
+hardware platform and that the upgrade did not introduce regressions in your
+configuration.
+.It
+After modifying the source tree to detect any new bugs and/or regressions.
+.It
+Periodically, maybe from a
+.Xr cron 8
+job, to ensure that any changes to the system (such as the installation of
+third-party packages or manual modifications to configuration files) do not
+introduce unexpected failures.
+.El
+.Ss Running the tests
+First, you will need to install the
+.Sq devel/kyua
+package from
+.Xr ports 7 .
+Then use the following command to run the whole test suite:
+.Bd -literal -offset indent
+$ kyua test -k /usr/tests/Kyuafile
+.Ed
+.Pp
+The above will iterate through all test programs in
+.Pa /usr/tests
+recursively, execute them, store their results and debugging data in Kyua's
+database (by default in
+.Pa ~/.kyua/store.db ) ,
+and print a summary of the results.
+This summary includes a brief count of all total tests run and how many of
+them failed.
+.Pp
+It is possible to restrict which tests to run by providing their names in
+the command line.
+For example, this would execute the tests for the
+.Xr cp 1
+and
+.Xr cut 1
+utilities:
+.Bd -literal -offset indent
+$ kyua test -k /usr/tests/Kyuafile bin/cp usr.bin/cut
+.Ed
+.Ss Obtaining reports of the tests execution
+Additional information about the test results can be retrieved
+by using Kyua's various reporting commands.
+For example, the following would print a plain-text report of the executed
+tests and show which ones failed:
+.Bd -literal -offset indent
+$ kyua report
+.Ed
+.Pp
+This example would generate an HTML report ready to be published on a
+web server:
+.Bd -literal -offset indent
+$ kyua report-html --output ~/public_html/tests
+.Ed
+.Pp
+For further details on the command-line interface of Kyua, please refer
+to its manual page
+.Xr kyua 1 .
+.Ss Configuring the tests
+Some test cases in the
+.Fx
+Test Suite require manual configuration by the administrator before they can be
+run.
+Unless certain properties are defined, the tests that require them will be
+skipped.
+.Pp
+Test suites are configured by defining their configuration
+variables in
+.Pa /usr/local/etc/kyua/kyua.conf .
+The format of this file is detailed in
+.Xr kyua.conf 5 .
+.Pp
+The following configuration variables are available in the
+.Fx
+Test Suite:
+.Bl -tag -width "allow_sysctl_side_effects"
+.It allow_devfs_side_effects
+If defined, enables tests that may destroy and recreate semipermanent device
+nodes, like disk devices.
+Without this variable, tests may still create and destroy devices nodes that
+are normally transient, like /dev/tap* and /dev/pts*, as long as they clean
+them up afterwards.
+However, tests that require this variable have a relaxed cleanup requirement;
+they must recreate any devices that they destroyed, but not necessarily with
+the same devnames.
+.It allow_sysctl_side_effects
+Enables tests that change globally significant
+.Xr sysctl 8
+variables.
+The tests will undo any changes in their cleanup phases.
+.It disks
+Must be set to a space delimited list of disk device nodes.
+Tests that need destructive access to disks must use these devices.
+Tests are not required to preserve any data present on these disks.
+.It fibs
+Must be set to a space delimited list of FIBs (routing tables).
+Tests that need to modify a routing table may use any of these.
+Tests will cleanup any new routes that they create.
+.El
+.Ss What to do if something fails?
+If there is
+.Em any failure
+during the execution of the test suite, please consider reporting it to the
+.Fx
+developers so that the failure can be analyzed and fixed.
+To do so, either send a message to the appropriate mailing list or file a
+problem report.
+For more details please refer to:
+.Bl -bullet -offset indent -compact
+.It
+.Lk http://lists.freebsd.org/ "FreeBSD Mailing Lists"
+.It
+.Lk http://www.freebsd.org/support.html "Problem Reporting"
+.El
+.Sh FILES
+.Bl -tag -compact -width usrXlocalXetcXkyuaXkyuaXconfXX
+.It Pa /usr/local/etc/kyua/kyua.conf
+System-wide configuration file for
+.Xr kyua 1 .
+.It Pa ~/.kyua/kyua.conf
+User-specific configuration file for
+.Xr kyua 1 ;
+overrides the system file.
+.It Pa ~/.kyua/store.db
+Default result database used by Kyua.
+.It Pa /usr/tests/
+Location of the
+.Fx
+Test Suite.
+.It Pa /usr/tests/Kyuafile
+Top-level test suite definition file.
+.El
+.Sh SEE ALSO
+.Xr kyua 1 ,
+.Xr build 7
+.Sh HISTORY
+The
+.Fx
+Test Suite first appeared in
+.Fx 10.1 .
+.Pp
+The
+.Nm
+manual page first appeared in
+.Nx 6.0
+and was later ported to
+.Fx 10.1 .
+.Sh AUTHORS
+.An Julio Merino Aq Mt jmmv at FreeBSD.org
Property changes on: trunk/share/man/man7/tests.7
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man7/tuning.7
===================================================================
--- trunk/share/man/man7/tuning.7 2018-06-03 14:01:43 UTC (rev 10288)
+++ trunk/share/man/man7/tuning.7 2018-06-03 16:51:25 UTC (rev 10289)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2001 Matthew Dillon. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -21,52 +22,28 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man7/tuning.7 293692 2016-01-11 20:10:14Z trasz $
.\"
-.Dd October 16, 2010
+.Dd December 8, 2012
.Dt TUNING 7
.Os
.Sh NAME
.Nm tuning
-.Nd performance tuning under MidnightBSD
+.Nd performance tuning under FreeBSD
.Sh SYSTEM SETUP - DISKLABEL, NEWFS, TUNEFS, SWAP
-When using
-.Xr bsdlabel 8
-or
-.Xr sysinstall 8
-to lay out your file systems on a hard disk it is important to remember
-that hard drives can transfer data much more quickly from outer tracks
-than they can from inner tracks.
-To take advantage of this you should
-try to pack your smaller file systems and swap closer to the outer tracks,
-follow with the larger file systems, and end with the largest file systems.
-It is also important to size system standard file systems such that you
-will not be forced to resize them later as you scale the machine up.
-I usually create, in order, a 128M root, 1G swap, 128M
-.Pa /var ,
-128M
-.Pa /var/tmp ,
-3G
-.Pa /usr ,
-and use any remaining space for
-.Pa /home .
-.Pp
-You should typically size your swap space to approximately 2x main memory
-for systems with less than 2GB of RAM, or approximately 1x main memory
+The swap partition should typically be approximately 2x the size of
+main memory
+for systems with less than 4GB of RAM, or approximately equal to
+the size of main memory
if you have more.
-If you do not have a lot of RAM, though, you will generally want a lot
-more swap.
-It is not recommended that you configure any less than
-256M of swap on a system and you should keep in mind future memory
+Keep in mind future memory
expansion when sizing the swap partition.
-The kernel's VM paging algorithms are tuned to perform best when there is
-at least 2x swap versus main memory.
Configuring too little swap can lead
to inefficiencies in the VM page scanning code as well as create issues
later on if you add more memory to your machine.
-Finally, on larger systems
+On larger systems
with multiple SCSI disks (or multiple IDE disks operating on different
-controllers), we strongly recommend that you configure swap on each drive.
+controllers), configure swap on each drive.
The swap partitions on the drives should be approximately the same size.
The kernel can handle arbitrary sizes but
internal data structures scale to 4 times the largest swap partition.
@@ -79,100 +56,7 @@
and even if you do not normally use much swap, it can give you more time to
recover from a runaway program before being forced to reboot.
.Pp
-How you size your
-.Pa /var
-partition depends heavily on what you intend to use the machine for.
-This
-partition is primarily used to hold mailboxes, the print spool, and log
-files.
-Some people even make
-.Pa /var/log
-its own partition (but except for extreme cases it is not worth the waste
-of a partition ID).
-If your machine is intended to act as a mail
-or print server,
-or you are running a heavily visited web server, you should consider
-creating a much larger partition \(en perhaps a gig or more.
-It is very easy
-to underestimate log file storage requirements.
-.Pp
-Sizing
-.Pa /var/tmp
-depends on the kind of temporary file usage you think you will need.
-128M is
-the minimum we recommend.
-Also note that sysinstall will create a
-.Pa /tmp
-directory.
-Dedicating a partition for temporary file storage is important for
-two reasons: first, it reduces the possibility of file system corruption
-in a crash, and second it reduces the chance of a runaway process that
-fills up
-.Oo Pa /var Oc Ns Pa /tmp
-from blowing up more critical subsystems (mail,
-logging, etc).
-Filling up
-.Oo Pa /var Oc Ns Pa /tmp
-is a very common problem to have.
-.Pp
-In the old days there were differences between
-.Pa /tmp
-and
-.Pa /var/tmp ,
-but the introduction of
-.Pa /var
-(and
-.Pa /var/tmp )
-led to massive confusion
-by program writers so today programs haphazardly use one or the
-other and thus no real distinction can be made between the two.
-So it makes sense to have just one temporary directory and
-softlink to it from the other
-.Pa tmp
-directory locations.
-However you handle
-.Pa /tmp ,
-the one thing you do not want to do is leave it sitting
-on the root partition where it might cause root to fill up or possibly
-corrupt root in a crash/reboot situation.
-.Pp
-The
-.Pa /usr
-partition holds the bulk of the files required to support the system and
-a subdirectory within it called
-.Pa /usr/local
-holds the bulk of the files installed from the
-.Xr ports 7
-hierarchy.
-If you do not use ports all that much and do not intend to keep
-system source
-.Pq Pa /usr/src
-on the machine, you can get away with
-a 1 gigabyte
-.Pa /usr
-partition.
-However, if you install a lot of ports
-(especially window managers and Linux-emulated binaries), we recommend
-at least a 2 gigabyte
-.Pa /usr
-and if you also intend to keep system source
-on the machine, we recommend a 3 gigabyte
-.Pa /usr .
-Do not underestimate the
-amount of space you will need in this partition, it can creep up and
-surprise you!
-.Pp
-The
-.Pa /home
-partition is typically used to hold user-specific data.
-I usually size it to the remainder of the disk.
-.Pp
-Why partition at all?
-Why not create one big
-.Pa /
-partition and be done with it?
-Then I do not have to worry about undersizing things!
-Well, there are several reasons this is not a good idea.
+It is not a good idea to make one large partition.
First,
each partition has different operational characteristics and separating them
allows the file system to tune itself to those characteristics.
@@ -181,27 +65,11 @@
.Pa /usr
partitions are read-mostly, with very little writing, while
a lot of reading and writing could occur in
-.Pa /var
-and
.Pa /var/tmp .
By properly
partitioning your system fragmentation introduced in the smaller more
heavily write-loaded partitions will not bleed over into the mostly-read
partitions.
-Additionally, keeping the write-loaded partitions closer to
-the edge of the disk (i.e., before the really big partitions instead of after
-in the partition table) will increase I/O performance in the partitions
-where you need it the most.
-Now it is true that you might also need I/O
-performance in the larger partitions, but they are so large that shifting
-them more towards the edge of the disk will not lead to a significant
-performance improvement whereas moving
-.Pa /var
-to the edge can have a huge impact.
-Finally, there are safety concerns.
-Having a small neat root partition that
-is essentially read-only gives it a greater chance of surviving a bad crash
-intact.
.Pp
Properly partitioning your system also allows you to tune
.Xr newfs 8 ,
@@ -208,86 +76,12 @@
and
.Xr tunefs 8
parameters.
-Tuning
-.Xr newfs 8
-requires more experience but can lead to significant improvements in
-performance.
-There are three parameters that are relatively safe to tune:
-.Em blocksize , bytes/i-node ,
-and
-.Em cylinders/group .
-.Pp
-.Fx
-performs best when using 8K or 16K file system block sizes.
-The default file system block size is 16K,
-which provides best performance for most applications,
-with the exception of those that perform random access on large files
-(such as database server software).
-Such applications tend to perform better with a smaller block size,
-although modern disk characteristics are such that the performance
-gain from using a smaller block size may not be worth consideration.
-Using a block size larger than 16K
-can cause fragmentation of the buffer cache and
-lead to lower performance.
-.Pp
-The defaults may be unsuitable
-for a file system that requires a very large number of i-nodes
-or is intended to hold a large number of very small files.
-Such a file system should be created with an 8K or 4K block size.
-This also requires you to specify a smaller
-fragment size.
-We recommend always using a fragment size that is 1/8
-the block size (less testing has been done on other fragment size factors).
-The
-.Xr newfs 8
-options for this would be
-.Dq Li "newfs -f 1024 -b 8192 ..." .
-.Pp
-If a large partition is intended to be used to hold fewer, larger files, such
-as database files, you can increase the
-.Em bytes/i-node
-ratio which reduces the number of i-nodes (maximum number of files and
-directories that can be created) for that partition.
-Decreasing the number
-of i-nodes in a file system can greatly reduce
-.Xr fsck 8
-recovery times after a crash.
-Do not use this option
-unless you are actually storing large files on the partition, because if you
-overcompensate you can wind up with a file system that has lots of free
-space remaining but cannot accommodate any more files.
-Using 32768, 65536, or 262144 bytes/i-node is recommended.
-You can go higher but
-it will have only incremental effects on
-.Xr fsck 8
-recovery times.
-For example,
-.Dq Li "newfs -i 32768 ..." .
-.Pp
+The only
.Xr tunefs 8
-may be used to further tune a file system.
-This command can be run in
-single-user mode without having to reformat the file system.
-However, this is possibly the most abused program in the system.
-Many people attempt to
-increase available file system space by setting the min-free percentage to 0.
-This can lead to severe file system fragmentation and we do not recommend
-that you do this.
-Really the only
-.Xr tunefs 8
-option worthwhile here is turning on
+option worthwhile turning on is
.Em softupdates
with
.Dq Li "tunefs -n enable /filesystem" .
-(Note: in
-.Fx 4.5
-and later, softupdates can be turned on using the
-.Fl U
-option to
-.Xr newfs 8 ,
-and
-.Xr sysinstall 8
-will typically enable softupdates automatically for non-root file systems).
Softupdates drastically improves meta-data performance, mainly file
creation and deletion.
We recommend enabling softupdates on most file systems; however, there
@@ -301,7 +95,7 @@
Secondly, softupdates delays the freeing of file system
blocks.
If you have a file system (such as the root file system) which is
-close to full, doing a major update of it, e.g.\&
+close to full, doing a major update of it, e.g.,\&
.Dq Li "make installworld" ,
can run it out of space and cause the update to fail.
For this reason, softupdates will not be enabled on the root file system
@@ -516,7 +310,7 @@
(exceeding the buffer cache's write threshold) can lead to extremely
bad clustering performance.
Do not set this value arbitrarily high!
-Higher write queueing values may also add latency to reads occurring at
+Higher write queuing values may also add latency to reads occurring at
the same time.
.Pp
The
@@ -525,8 +319,8 @@
to pre-read if the heuristics algorithm decides that the reads are
issued sequentially.
It is used by the UFS, ext2fs and msdosfs file systems.
-With the default UFS block size of 16 KiB, a setting of 32 will allow
-speculatively reading up to 512 KiB.
+With the default UFS block size of 32 KiB, a setting of 64 will allow
+speculatively reading up to 2 MiB.
This setting may be increased to get around disk I/O latencies, especially
where these latencies are large such as in virtual machine emulated
environments.
@@ -645,7 +439,7 @@
the acknowledgement may be sent in its own packet, before the remote service
has a chance to echo the data it just received.
This same concept also
-applies to any interactive protocol (e.g.\& SMTP, WWW, POP3), and can cut the
+applies to any interactive protocol (e.g.,\& SMTP, WWW, POP3), and can cut the
number of tiny packets flowing across the network in half.
The
.Fx
@@ -666,52 +460,6 @@
sysctl rather than disable delayed acks.
.Pp
The
-.Va net.inet.tcp.inflight.enable
-sysctl turns on bandwidth delay product limiting for all TCP connections.
-The system will attempt to calculate the bandwidth delay product for each
-connection and limit the amount of data queued to the network to just the
-amount required to maintain optimum throughput.
-This feature is useful
-if you are serving data over modems, GigE, or high speed WAN links (or
-any other link with a high bandwidth*delay product), especially if you are
-also using window scaling or have configured a large send window.
-If you enable this option, you should also be sure to set
-.Va net.inet.tcp.inflight.debug
-to 0 (disable debugging), and for production use setting
-.Va net.inet.tcp.inflight.min
-to at least 6144 may be beneficial.
-Note however, that setting high
-minimums may effectively disable bandwidth limiting depending on the link.
-The limiting feature reduces the amount of data built up in intermediate
-router and switch packet queues as well as reduces the amount of data built
-up in the local host's interface queue.
-With fewer packets queued up,
-interactive connections, especially over slow modems, will also be able
-to operate with lower round trip times.
-However, note that this feature
-only affects data transmission (uploading / server-side).
-It does not
-affect data reception (downloading).
-.Pp
-Adjusting
-.Va net.inet.tcp.inflight.stab
-is not recommended.
-This parameter defaults to 20, representing 2 maximal packets added
-to the bandwidth delay product window calculation.
-The additional
-window is required to stabilize the algorithm and improve responsiveness
-to changing conditions, but it can also result in higher ping times
-over slow links (though still much lower than you would get without
-the inflight algorithm).
-In such cases you may
-wish to try reducing this parameter to 15, 10, or 5, and you may also
-have to reduce
-.Va net.inet.tcp.inflight.min
-(for example, to 3500) to get the desired effect.
-Reducing these parameters
-should be done as a last resort only.
-.Pp
-The
.Va net.inet.ip.portrange.*
sysctls control the port number ranges automatically bound to TCP and UDP
sockets.
@@ -756,7 +504,7 @@
For such environments,
we recommend increasing this value to 1024 or higher.
The service daemon
-may itself limit the listen queue size (e.g.\&
+may itself limit the listen queue size (e.g.,\&
.Xr sendmail 8 ,
apache) but will
often have a directive in its configuration file to adjust the queue size up.
@@ -947,42 +695,12 @@
Additionally, higher-end CPUs support
4MB MMU pages, which the kernel uses to map the kernel itself into memory,
increasing its efficiency under heavy syscall loads.
-.Sh IDE WRITE CACHING
-.Fx 4.3
-flirted with turning off IDE write caching.
-This reduced write bandwidth
-to IDE disks but was considered necessary due to serious data consistency
-issues introduced by hard drive vendors.
-Basically the problem is that
-IDE drives lie about when a write completes.
-With IDE write caching turned
-on, IDE hard drives will not only write data to disk out of order, they
-will sometimes delay some of the blocks indefinitely under heavy disk
-load.
-A crash or power failure can result in serious file system
-corruption.
-So our default was changed to be safe.
-Unfortunately, the
-result was such a huge loss in performance that we caved in and changed the
-default back to on after the release.
-You should check the default on
-your system by observing the
-.Va hw.ata.wc
-sysctl variable.
-If IDE write caching is turned off, you can turn it back
-on by setting the
-.Va hw.ata.wc
-loader tunable to 1.
-More information on tuning the ATA driver system may be found in the
-.Xr ata 4
-manual page.
-If you need performance, go with SCSI.
.Sh CPU, MEMORY, DISK, NETWORK
The type of tuning you do depends heavily on where your system begins to
bottleneck as load increases.
If your system runs out of CPU (idle times
-are perpetually 0%) then you need to consider upgrading the CPU or moving to
-an SMP motherboard (multiple CPU's), or perhaps you need to revisit the
+are perpetually 0%) then you need to consider upgrading the CPU
+or perhaps you need to revisit the
programs that are causing the load and try to optimize them.
If your system
is paging to swap a lot you need to consider adding more memory.
@@ -1001,21 +719,15 @@
start seeking around the disk SCSI drives usually win.
.Pp
Finally, you might run out of network suds.
-The first line of defense for
-improving network performance is to make sure you are using switches instead
-of hubs, especially these days where switches are almost as cheap.
-Hubs
-have severe problems under heavy loads due to collision back-off and one bad
-host can severely degrade the entire LAN.
-Second, optimize the network path
+Optimize the network path
as much as possible.
For example, in
.Xr firewall 7
we describe a firewall protecting internal hosts with a topology where
the externally visible hosts are not routed through it.
-Use 100BaseT rather
-than 10BaseT, or use 1000BaseT rather than 100BaseT, depending on your needs.
-Most bottlenecks occur at the WAN link (e.g.\&
+Use 1000BaseT rather
+than 100BaseT, depending on your needs.
+Most bottlenecks occur at the WAN link (e.g.,\&
modem, T1, DSL, whatever).
If expanding the link is not an option it may be possible to use the
.Xr dummynet 4
@@ -1041,10 +753,11 @@
.Xr hier 7 ,
.Xr ports 7 ,
.Xr boot 8 ,
-.Xr bsdlabel 8 ,
+.Xr bsdinstall 8 ,
.Xr ccdconfig 8 ,
.Xr config 8 ,
.Xr fsck 8 ,
+.Xr gpart 8 ,
.Xr gjournal 8 ,
.Xr gstripe 8 ,
.Xr gvinum 8 ,
@@ -1055,7 +768,6 @@
.Xr newfs 8 ,
.Xr route 8 ,
.Xr sysctl 8 ,
-.Xr sysinstall 8 ,
.Xr tunefs 8
.Sh HISTORY
The
@@ -1066,3 +778,5 @@
in
.Fx 4.3 ,
May 2001.
+The manual page was greatly modified by
+.An Eitan Adler Aq eadler at FreeBSD.org
Property changes on: trunk/share/man/man7/tuning.7
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
More information about the Midnightbsd-cvs
mailing list