Module Name: src
Committed By: snj
Date: Sat Sep 19 07:06:55 UTC 2009
Modified Files:
src/share/man/man7: release.7
Log Message:
Sync with reality.
To generate a diff of this commit:
cvs rdiff -u -r1.30 -r1.31 src/share/man/man7/release.7
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man7/release.7
diff -u src/share/man/man7/release.7:1.30 src/share/man/man7/release.7:1.31
--- src/share/man/man7/release.7:1.30 Tue Sep 15 01:20:42 2009
+++ src/share/man/man7/release.7 Sat Sep 19 07:06:55 2009
@@ -1,4 +1,4 @@
-.\" $NetBSD: release.7,v 1.30 2009/09/15 01:20:42 jnemeth Exp $
+.\" $NetBSD: release.7,v 1.31 2009/09/19 07:06:55 snj Exp $
.\"
.\" Copyright (c) 1997, 2000, 2005 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -27,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd September 14, 2009
+.Dd September 19, 2009
.Dt RELEASE 7
.Os
.Sh NAME
@@ -45,7 +45,7 @@
.It Aq Em machine
The platform for which the release was built, corresponding to the
.Em hw.machine
-sysctl variable, e.g.
+sysctl variable, e.g.,
.Em i386
or
.Em amiga .
@@ -53,12 +53,12 @@
The architecture for which a particular installation set was built,
corresponding to the
.Em hw.machine_arch
-sysctl variable, e.g.
+sysctl variable, e.g.,
.Em i386
or
.Em m68k .
.It Aq Em rel
-The target release.
+The release version number.
.El
.Pp
All
@@ -70,42 +70,25 @@
.Sy README
file at the top-level,
describing who built the snapshot and under what circumstances
-.Po e.g. whether it's an official
+.Po e.g., whether it's an official
.Nx
snapshot, or not
.Pc .
.Pp
All
-.Sy BSDSUM
-files are historic
-.Bx
-checksums for the various files in that directory,
-in the format produced by the command:
-.Sy cksum -o 1 Aq Sy file .
-.Pp
-All
-.Sy CKSUM
-files are POSIX checksums for the various files in that directory, in the
-format produced by the command:
-.Sy cksum Aq Sy file .
-.Pp
-All
.Sy MD5
files are MD5 digests for the various files in that directory, in the
format produced by the command:
.Sy cksum -m Aq Sy file .
.Pp
All
-.Sy SYSVSUM
-files are historic
-.At V
-checksums for the various files in
-that directory, in the format produced by the command:
-.Sy cksum -o 2 Aq Sy file .
-.Pp
-The MD5 digest is the safest checksum, followed by the POSIX checksum.
-The other two checksums are provided only to ensure that the widest possible
-range of system can check the integrity of the release files.
+.Sy SHA512
+files are SHA512 digests for the various files in that directory, in the
+format produced by the command:
+.Sy cksum -a SHA512 Aq Sy file .
+.Pp
+The SHA512 digest is safer, but MD5 checksums are provided so that a wider
+range of operating systems can check the integrity of the release files.
.Pp
Files that end in
.Sy .tgz
@@ -125,9 +108,6 @@
include the leading
.Dq / .
.Pp
-All compression of release files is to be performed with the command:
-.Sy gzip -9 .
-.Pp
The root of the release hierarchy may be the root directory of a
CD-ROM, but in all other cases it should be
.Sm off
@@ -142,12 +122,6 @@
files and subdirectories:
.Pp
.Bl -tag -width "\*[Lt]machine\*[Gt]"
-.It Sy SOURCE_DATE
-A file containing the date, in UTC, of the source code from which the
-release or snapshot was built, in the default format produced by the
-command:
-.Sy date -u .
-.
.It Sy iso/
CDROM images in ISO 9660 format, usually created with
.Dq ./build.sh ... iso-image ...
@@ -172,9 +146,9 @@
.Sy /installation/cdrom/
.Xc
.Sm on
-directory, should contain file systems that
+directory, contain file systems that
have an internal layout that corresponds to
-a complete release for one or more machine types.
+a complete release for a given machine type.
If built with
.Dq iso-image-source ,
then it will also contain a
@@ -182,12 +156,9 @@
directory.
These images are usually bootable.
.Bl -tag -width "\*[Lt]machine_arch\*[Gt]cd.iso"
-.It Sy BSDSUM
-.It Sy CKSUM
.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Ao Em machine_arch Ac Ns Sy cd.iso
+.It Sy SHA512
+.It Ao Em machine Ac Ns Sy cd.iso
.El
.
.It Sy shared/
@@ -219,55 +190,26 @@
.El
.
.It Sy source/
-Source codes of the operating system and patches for it
-should be put into
+Source code of the operating system should be put into
.Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /source/
using the following layout:
.Pp
-.Bl -tag -width "patches/"
-.It Sy patches/
-This directory contains various patch files appropriate for
-.Xr patch 1 .
-Other patches may exist for fixing critical problems.
-.Bl -tag -width "sharesrc.tgz"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy diff- Ns Ao Em lastrel Ac Ns Sy - Ns Ao Em rel Ac Ns Sy .gz
-Diff against the last release, usually generated by
-.Ic cvs rdiff .
-For patch releases, diffs against the last release
-are included.
-If the last release was a patch release itself, the
-diff is against that patch release is included.
-.El
+.Bl -tag -width "sets/"
.It Sy sets/
-Sources for the various system sets, based on their modules
-in the CVS server.
-.\" XXX how are these generated? Separate checkout of each module?
+Sources for the various system sets.
.Bl -tag -width "sharesrc.tgz"
-.It Sy BSDSUM
-.It Sy CKSUM
.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
+.It Sy SHA512
.It Sy gnusrc.tgz
Contains sources for all GPLed and possibly other programs that
contains restrictions in their licensing that prevent others from
using these programs in closed-source environments.
-.It Sy pkgsrc.tgz
-Package-sources for third party software ready to compile.
-See
-.Pa pkgsrc/README
-for more information.
.It Sy sharesrc.tgz
Contains machine-independent data files that can be shared across
architectures/systems.
.It Sy src.tgz
The operating system's userland source code, including all programs,
-tools, toolchain, etc.
+tools, libraries, etc.
.It Sy syssrc.tgz
Kernel sources for all architectures plus sources of the tools needed
to build kernels (like
@@ -291,35 +233,32 @@
.Sy /
.Xc
.Sm on
-follow the following layout:
+fit the following layout:
.Bl -tag -width "installation/"
.It Sy INSTALL.txt
Installation notes, including complete descriptions of files contained
within the release hierarchy
.It Sy INSTALL.more
-pretty version of this, suited for viewing with
+pretty version, suited for viewing with
.Xr more 1
.It Sy INSTALL.html
-HTML version of this
+HTML version
.It Sy INSTALL.ps
-PostScript version of this
+PostScript version
.It Sy binary/
system binaries
-.Bl -tag -width "SYSVSUM/"
+.Bl -tag -width "SHA512/"
.It Sy sets/
installation sets
-.Bl -tag -width "xcontrib.tgz"
-.It Sy BSDSUM
-.It Sy CKSUM
+.Bl -tag -width "xserver.tgz"
.It Sy MD5
-.It Sy SYSVSUM
+.It Sy SHA512
.It Sy base.tgz
The base binary distribution.
This set contains the base
.Nx
utilities that are necessary for the system to run and be minimally
functional.
-It includes shared libraries for those architectures that support them.
This set excludes all things listed in the sets
described below.
.It Sy comp.tgz
@@ -329,7 +268,7 @@
manual pages.
It also includes the system include files
.Pq Pa /usr/include
-, and the static system libraries.
+and the static system libraries.
.It Sy etc.tgz
This set contains the system configuration files that reside in
.Pa /etc
@@ -344,9 +283,9 @@
.Sy base
set which are not included in the other sets.
.It Sy misc.tgz
-This set includes the system dictionaries (which are rather large), the
-typesettable document set, and manual pages for other architectures, which
-happen to be installed from the source tree by default.
+This set includes miscellaneous non-essential files, including dictionaries,
+the typesettable document set, and various other documentation and example
+configuration files.
.It Sy modules.tgz
This set includes all the kernel modules.
.It Sy text.tgz
@@ -356,31 +295,22 @@
.Xr groff 1 ,
all related programs, and their manual pages.
.It Sy xbase.tgz
-This set includes the base X11 distribution, including manual pages and
-shared libraries for those architectures that support them, and excluding
-everything contained in the other X11 sets.
+This set includes the base X11 distribution, including manual pages
+and excluding everything contained in the other X11 sets.
.It Sy xcomp.tgz
This set includes the X11 include files and static X11 libraries.
-.It Sy xcontrib.tgz
-This set includes binaries and manual pages for programs built from the
-X11
-.Dq contrib
-sources.
.It Sy xfont.tgz
This set includes the X11 fonts.
.It Sy xserver.tgz
This set includes the X servers and manual pages for
-.Aq machine .
+a given machine.
.Em "Note: this set may not be available on some platforms" .
.El
.It Sy kernel/
suitably named, gzipped kernels
.Bl -tag -width "netbsd-GENERIC.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
+.It Sy SHA512
.It Sy netbsd-GENERIC.gz
A kernel built from the
.Sy GENERIC
@@ -393,92 +323,82 @@
installation helper items
.Bl -tag -width "diskimage/"
.It Sy cdrom/
-CDROM images in ISO 9660 format, usually created as part of
+CDROM images in ISO 9660 format, created as part of
.Dq build.sh ... release ...
in
.Pa src .
.Pp
-Images in this directory will typically be bootable,
-and will contain one or more of a kernel, installation tools,
-and rescue tools.
-They will not contain installation sets, source sets, or
+Images in this directory are bootable, and contain one a kernel,
+installation tools, and rescue tools.
+They do not contain installation sets, source sets, or
other components of a complete release.
-.Bl -tag -width "netbsd-ARCH.iso"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy netbsd- Ns Ao Em machine_arch Ac Ns Sy .iso
+.Pp
+.Em "Note: These images are only present in the amd64 and i386 distributions."
+.Bl -tag -width "boot-com.iso"
+.It Sy MD5
+.It Sy SHA512
+.It Sy boot.iso
+VGA console
+.It Sy boot-com.iso
+Serial console
.El
.It Sy diskimage/
-disk images, for those platforms that provide them
-.Bl -tag -width "diskimage-rz25.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy diskimage-rz25.gz
+disk images, on those platforms that provide them
+.Bl -tag -width "diskimage.gz"
+.It Sy MD5
+.It Sy SHA512
+.It Sy diskimage.gz
.El
.It Sy floppy/
-floppy images, for those platforms that provide them
-.Bl -tag -width "floppy-144.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy floppy-144.gz
+floppy images, on those platforms that provide them
+.Bl -tag -width "boot1.fs"
+.It Sy MD5
+.It Sy SHA512
+.It Sy boot1.fs
+.It Sy boot2.fs
+.El
+.It Sy instkernel/
+installation kernels for platforms that can boot them directly
+.Bl -tag -width netbsd.gz
+.It Sy MD5
+.It Sy SHA512
+.It Sy netbsd.gz
.El
.It Sy miniroot/
-miniroot images, for those platforms that provide them
-.Bl -tag -width "miniroot.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy miniroot.gz
+miniroot images, on those platforms that provide them
+.Bl -tag -width "miniroot.fs.gz"
+.It Sy MD5
+.It Sy SHA512
+.It Sy miniroot.fs.gz
.El
.It Sy misc/
miscellaneous installation helper utilities, including boot selectors,
floppy writing software, other software that runs under foreign operating
systems, etc.
-.Bl -tag -width "CKSUMS"
-.It Sy BSDSUM
-.It Sy CKSUM
+.Bl -tag -width "SHA512"
.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
+.It Sy SHA512
.It Sy ...
.El
.It Sy netboot/
network boot programs
.Bl -tag -width "netboot.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
+.It Sy SHA512
.It Sy netboot.gz
.El
.It Sy tapeimage/
-tape images, for those platforms that provide them
-.Bl -tag -width "tapeimage-hp9144.gz"
-.It Sy BSDSUM
-.It Sy CKSUM
-.It Sy MD5
-.It Sy README
-.It Sy SYSVSUM
-.It Sy tapeimage-hp9144.gz
+tape images, on those platforms that provide them
+.Bl -tag -width "tapeboot"
+.It Sy MD5
+.It Sy SHA512
+.It Sy tapeboot
.El
.El
.El
.El
.Sh SEE ALSO
.Xr cksum 1 ,
-.Xr date 1 ,
.Xr gzip 1 ,
.Xr split 1 ,
.Xr tar 1
