[src/trunk]: src/distrib/notes Introduce some initial documentation for NetBS...

[phx <phx%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/9ba6b551f144
branches:  trunk
changeset: 773242:9ba6b551f144
user:      phx <phx%NetBSD.org@localhost>
date:      Sun Jan 29 15:54:35 2012 +0000

description:
Introduce some initial documentation for NetBSD/ofppc.

diffstat:

 distrib/notes/Makefile       |    3 +-
 distrib/notes/ofppc/Makefile |    5 +
 distrib/notes/ofppc/contents |  275 +++++++++++++++++++++++++++++++++++++++++++
 distrib/notes/ofppc/hardware |   23 +++
 distrib/notes/ofppc/install  |   13 ++
 distrib/notes/ofppc/legal    |    2 +
 distrib/notes/ofppc/prep     |   58 +++++++++
 distrib/notes/ofppc/upgrade  |   28 ++++
 distrib/notes/ofppc/xfer     |   34 +++++
 9 files changed, 440 insertions(+), 1 deletions(-)

diffs (truncated from 487 to 300 lines):

diff -r 04bf4defa00a -r 9ba6b551f144 distrib/notes/Makefile
--- a/distrib/notes/Makefile    Sun Jan 29 15:32:52 2012 +0000
+++ b/distrib/notes/Makefile    Sun Jan 29 15:54:35 2012 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.42 2011/01/26 01:18:44 pooka Exp $
+#      $NetBSD: Makefile,v 1.43 2012/01/29 15:54:35 phx Exp $
 #
 
 .include <bsd.own.mk>
@@ -36,6 +36,7 @@
 SUBDIR+= news68k
 SUBDIR+= newsmips
 SUBDIR+= next68k
+SUBDIR+= ofppc
 SUBDIR+= pmax
 SUBDIR+= prep
 SUBDIR+= sandpoint
diff -r 04bf4defa00a -r 9ba6b551f144 distrib/notes/ofppc/Makefile
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/distrib/notes/ofppc/Makefile      Sun Jan 29 15:54:35 2012 +0000
@@ -0,0 +1,5 @@
+#      $NetBSD: Makefile,v 1.1 2012/01/29 15:54:35 phx Exp $
+
+MERGED_SRCS+=  ${COMMON}/sysinst ${COMMON}/upgrade ${COMMON}/xfer
+
+.include <bsd.man.mk>
diff -r 04bf4defa00a -r 9ba6b551f144 distrib/notes/ofppc/contents
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/distrib/notes/ofppc/contents      Sun Jan 29 15:54:35 2012 +0000
@@ -0,0 +1,275 @@
+.\"    $NetBSD: contents,v 1.1 2012/01/29 15:54:35 phx Exp $
+.\"
+.\" Copyright (c) 1999-2012 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.
+.\"
+.
+.Ss2 NetBSD/\*M subdirectory structure
+The \*M-specific portion of the
+.Nx
+\*V release is found in the
+.Pa \*M
+subdirectory of the distribution:
+.ie \n[FOR_RELEASE] .Pa \&.../NetBSD-\*V/\*M/ .
+.el .Pa Pf \&.../arch/\*M/snapshot/ Ar yyyymmdd/ .
+It contains the following files and directories:
+.Pp
+.(tag INSTALL.html -compact \" top level
+.      It Pa INSTALL.html
+.      It Pa INSTALL.ps
+.      It Pa INSTALL.txt
+.      It Pa INSTALL.more
+Installation notes in various file formats, including this file.
+The
+.Pa \&.more
+file contains underlined text using the
+.Xr more 1
+conventions for indicating italic and bold display.
+.
+.\" MD binary and installation directories ---------------------------
+.
+.      It Pa binary/
+.
+.      (tag kernel/ -compact \" binary/
+.
+.              It Pa kernel/
+.
+.              (tag netbsd.gz -compact \" binary/kernel
+.
+.                      It Pa netbsd-GENERIC.gz
+A gzipped
+.Nx
+kernel containing code for everything supported in this release.
+.
+.                      It Pa netbsd-INSTALL.gz
+A gzipped kernel for installing or upgrading
+.Nx
+on your hardware.
+.
+.              tag) \" binary/kernel/
+.
+.              It Pa sets/
+.
+\*M binary distribution sets;
+see below.
+.
+.      tag) \" binary/
+.
+.      It Pa installation/
+.
+.      (tag miniroot/ -compact \" installation/
+.
+.              It Pa netboot/
+.
+.              (tag netboot -compact \" installtion/netboot
+.
+.                      It Pa netbsd-GENERIC.gz
+A gzipped
+.Nx
+kernel containing code for everything supported in this release.
+.
+.                      It Pa netbsd-INSTALL.gz
+A gzipped kernel for installing or upgrading
+.Nx
+on your hardware.
+.                      It Pa ofwboot
+A bootloader, which can start a kernel from your root partition, supporting
+.Tn MBR
+and
+.Tn RDB
+partition layouts.
+.
+.      tag) \" installation/
+.
+.tag) \" top level
+.
+.\" ------------------------------------------------------------------
+.
+.
+.Ss2 Binary distribution sets
+.\"
+.\" ------------------------------------------------------------------
+.\" XXX: most sets except kern and xserver should be in notes/common
+.\"
+The
+.Nx
+\*M
+binary distribution sets contain the binaries which
+comprise the
+.Nx
+\*V release for \*M.
+The binary distribution sets can be found in the
+.Pa \*M/binary/sets
+subdirectory
+of the
+.Nx
+\*V
+distribution tree, and are as follows:
+.(tag xserver \" sets
+.
+.It Sy base
+The
+.Nx
+\*V
+\*M
+.Sy base
+binary distribution.
+You
+.Em must
+install this distribution set.
+It contains the base
+.Nx
+utilities that are necessary for the
+system to run and be minimally functional.
+.
+.It Sy comp
+Things needed for compiling programs.
+This set includes the system include files
+.Pq Pa /usr/include
+and the various system libraries (except the shared
+libraries, which are included as part of the
+.Sy base
+set).
+This set also includes the manual pages for
+all of the utilities it contains, as well as the
+system call and library manual pages.
+.
+.It Sy etc
+This distribution set contains the system
+configuration files that reside in
+.Pa /etc
+and in several other places.
+This set
+.Em must
+be installed if you are installing the system from scratch, but should
+.Em not
+be used if you are upgrading.
+.
+.It Sy games
+This set includes the games and their manual pages.
+.
+.\" MD kernel set(s) -------------------------------------------------
+.
+.It Sy kern-GENERIC
+This set contains a
+.Nx*M
+\*V
+.Li GENERIC
+kernel, named
+.Pa /netbsd .
+You
+.Em must
+install this distribution set.
+.
+.\" ------------------------------------------------------------------
+.
+.It Sy man
+This set includes all of the manual pages for the
+binaries and other software contained in the
+.Sy base
+set.
+Note that it does not include any of the manual pages
+that are included in the other sets.
+.
+.It Sy misc
+This set includes the system dictionaries,
+the typesettable document set, and other files from
+.Pa /usr/share .
+.
+.It Sy text
+This set includes
+.Nx Ns 's
+text processing tools, including
+.Xr groff 1 ,
+all related programs, and their manual pages.
+.
+.tag) \" sets
+.
+.
+.\" X sets -----------------------------------------------------------
+.\" XXX: XOrg vs XFree
+.\" XXX: ports without xserver
+.Pp
+.Nx
+maintains its own set of sources for the X Window System in order to
+assure tight integration and compatibility.
+These sources are based on
+X.Org.
+Binary sets for the X Window System are distributed with
+.Nx .
+The sets are:
+.(tag xserver \" x sets
+.
+.It Sy xbase
+The basic files needed for a complete X
+client environment.
+This does not include the X servers.
+.
+.It Sy xcomp
+The extra libraries and include files needed to compile X source code.
+.
+.It Sy xfont
+Fonts needed by the X server and by X clients.
+.
+.It Sy xetc
+Configuration files for X which could be locally modified.
+.
+.It Sy xserver
+The X server. 
+.
+.tag) \" x sets
+.
+.
+.\" ------------------------------------------------------------------
+.
+.
+.\" MI DISCUSSION OF BINARY SETS -------------------------------------
+.\" XXX: should be in notes/common
+.
+.Pp
+The \*M binary distribution sets are distributed as gzipped tar files
+named with the extension
+.Sy .tgz ,
+e.g.
+.Pa base.tgz .
+.
+.
+.Pp
+The instructions given for extracting the source sets work equally
+well for the binary sets, but it is worth noting that if you use that
+method, the filenames stored in the sets are relative and therefore
+the files are extracted
+.Em below the current directory .
+Therefore, if you want to extract the binaries into your system, i.e.
+replace the system binaries with them, you have to run the
+.Ic "tar -xzpf"
+command from the root directory (
+.Pa / 
+) of your system.
+.