Home | History | Annotate | Download | only in stand
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms of the
      5 # Common Development and Distribution License, Version 1.0 only
      6 # (the "License").  You may not use this file except in compliance
      7 # with the License.
      8 #
      9 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
     10 # or http://www.opensolaris.org/os/licensing.
     11 # See the License for the specific language governing permissions
     12 # and limitations under the License.
     13 #
     14 # When distributing Covered Code, include this CDDL HEADER in each
     15 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     16 # If applicable, add the following below this CDDL HEADER, with the
     17 # fields enclosed by brackets "[]" replaced with your own identifying
     18 # information: Portions Copyright [yyyy] [name of copyright owner]
     19 #
     20 # CDDL HEADER END
     21 #
     22 # Copyright 1996 Sun Microsystems, Inc.  All rights reserved.
     23 # Use is subject to license terms.
     24 #
     25 # ident	"%Z%%M%	%I%	%E% SMI"
     26 
     27 README file for the usr/src/stand directory:	(tpl 8/1/94)
     28 					please update this as required
     29 
     30 This tree has source code for both sparc and x86 platforms.
     31 1). The lint target is implemented, but the source tree is not lint-free yet.
     32 2). It is too much of a change to "clean-up" this directory at the time
     33     of stand and stand.i386 merge.  So, let's use the following rule for
     34     the benefit of all.
     35     Each time you check in a new version of a file, please try to
     36 	a). lint that file individually
     37 	b). cstyle that file
     38 3). Please avoid using the following fragments in the common/ directory
     39 	#ifdef i386
     40 	#ifdef sparc
     41 4). The following fragment is non-ideal for the merge (promif) source base
     42 	#ifdef I386BOOT
     43      It should be removed, re-org'ed after a good understanding of the
     44      pieces involved and with suitable testing.
     45 5). If you change "common" source files including Makefiles, you have
     46     to build [ and test ] for all platforms.
     47 6). The following list should be addressed and eliminated as we continue
     48     to separate the PSM code out of shared common (PIM) code
     49     a). nfs_readsize for sun4 and i386.
     50     b). lib/fs/nfs_inet/netaddr.h: MAX_PKT_SIZE different between i386 and sparc
     51     c). lib/fs/nfs_inet/nfsops.c: boot_nfs_read() uses local buffer for i386 case
     52     d). all #ifdef sparc caused by prom_getversion() calls
     53 
     54 Commonly asked questions and brief answers:
     55 
     56 Q: Why is inetboot packaged differently?
     57 A: inetboot is loaded by PROM code, especially old PROMs.  They load
     58    to certain specific address and can only recognize a.out header.
     59    Thus, inetboot has to be packaged accordingly.  Note that the bootblk
     60    for sparc has the same constraints.  These historical reasons do
     61    not apply for i386 architecture.
     62