Home | History | Annotate | Download | only in checkenv
      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 (the "License").
      6 # You may not use this file except in compliance with the License.
      7 #
      8 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9 # or http://www.opensolaris.org/os/licensing.
     10 # See the License for the specific language governing permissions
     11 # and limitations under the License.
     12 #
     13 # When distributing Covered Code, include this CDDL HEADER in each
     14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15 # If applicable, add the following below this CDDL HEADER, with the
     16 # fields enclosed by brackets "[]" replaced with your own identifying
     17 # information: Portions Copyright [yyyy] [name of copyright owner]
     18 #
     19 # CDDL HEADER END
     20 #
     21 
     22 #
     23 # Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
     24 # Use is subject to license terms.
     25 #
     26 # ident	"@(#)README	1.2	08/11/21 SMI"
     27 #
     28 
     29 ===============================================================================
     30 
     31 Overview
     32 
     33 checkenv is a harness-independent tool which provides a framework for a test
     34 suite to define and verify its test requirements.  All test suites have
     35 requirements that must be met before they can be built, configured or executed.
     36 For some test suites, the requirements can be simple, such as the installation
     37 of core Solaris components with a common build environment. However, for many
     38 test suites, the requirements can be complex. For example, tests suites may
     39 depend upon the availability of one or more of the following:
     40 
     41 	* a minimum number of CPUs on the system
     42 	* extra network interfaces
     43 	* a minimum number of spare disk partitions
     44 	* packages not in core Solaris
     45 	* non-standard application software 
     46 	* non-basic Solaris configurations (ie. non-global zones)
     47 
     48 checkenv provides a standard way to check for such dependencies.
     49 
     50 ===============================================================================
     51 
     52 Installing the Package
     53 
     54 To install the checkenv package, use the following command as super user:
     55 
     56 	% pkgadd -d <package location>  SUNWstc-checkenv
     57 
     58 Where <package location> refers to the path containing the SUNWstc-checkenv 
     59 package directory. This will install checkenv into the /opt/SUNWstc-checkenv
     60 directory.
     61 
     62 ===============================================================================
     63 
     64 Removing the Package
     65 
     66 It is recommended that you install the package from scratch, rather than on
     67 top of an existing installation.  Thus, if an old version of the package is
     68 present use the following command as super user to remove the package:
     69 
     70         % pkgrm SUNWstc-checkenv
     71 
     72 ===============================================================================
     73 
     74 Building the Package (Optional)
     75 
     76 If you need to create the checkenv package from the source code use the 
     77 following steps:
     78 
     79 	# set path to STF bin directory
     80 	% PATH=<path-to-STF>/bin/`uname -p`:$PATH
     81 	% export PATH
     82 
     83 	# build checkenv proto area and package 
     84 	% cd <workspace_path>/usr/src/tools/checkenv
     85 	% make package
     86 
     87 The binaries will be located in the proto area at:
     88 <workspace_path>/proto/tools/checkenv
     89 
     90 The SUNWstc-checkenv package will be located at:
     91 <workspace_path>/packages/`uname -p`
     92 
     93