usr/src/tools/scripts/checkpaths.1onbld

   1 .\" Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
   2 .\" Use is subject to license terms.
   3 .\"
   4 .\" CDDL HEADER START
   5 .\"
   6 .\" The contents of this file are subject to the terms of the
   7 .\" Common Development and Distribution License, Version 1.0 only
   8 .\" (the "License").  You may not use this file except in compliance
   9 .\" with the License.
  10 .\"
  11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  12 .\" or http://www.opensolaris.org/os/licensing.
  13 .\" See the License for the specific language governing permissions
  14 .\" and limitations under the License.
  15 .\"
  16 .\" When distributing Covered Code, include this CDDL HEADER in each
  17 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  18 .\" If applicable, add the following below this CDDL HEADER, with the
  19 .\" fields enclosed by brackets "[]" replaced with your own identifying
  20 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  21 .\"
  22 .\" CDDL HEADER END
  23 .\"
  24 .TH CHECKPATHS 1ONBLD "Sep 25, 2003"
  25 .SH NAME
  26 .I checkpaths
  27 \- check file path containing files
  28 .SH SYNOPSIS
  29 \fBcheckpaths [-b] [root_paths...]\fP
  30 .SH DESCRIPTION
  31 .LP
  32 .I checkpaths
  33 inspects the contents of various files within an OS-Net workspace to
  34 ensure that the file paths listed in those files are valid.  This
  35 provides an integrity check of the workspace to catch cases where a
  36 file was removed or renamed without updating the corresponding
  37 \fIexception_list\fP entry.
  38 .LP
  39 .I checkpaths
  40 is typically called from \fBnightly(1ONBLD)\fP.  It may be invoked
  41 interactively within a workspace, and requires that at least
  42 \fI$SRCTOP\fP is set to a valid workspace.  It is not necessary
  43 that a full build has been performed in the workspace to be tested,
  44 but if full build(s) are not available under the
  45 \fI$SRCTOP/proto/\fP directory, then the corresponding exclusion
  46 lists are not verified.
  47 .SH OPTIONS
  48 .LP
  49 The following options are supported:
  50 .TP 4
  51 .B \-b
  52 Disable processing of files that list derived (built) objects.  This
  53 should be set if the \fI$SRCTOP/proto/\fP directory exists, but
  54 the contents are known to be bad.  \fBnightly(1ONBLD)\fP will typically set
  55 this flag if the build fails.
  56 .TP 4
  57 .B root_paths...
  58 By default, checkpaths validates all of the proto areas for known
  59 architectures that exist in the \fI$SRCTOP/proto/\fP directory.
  60 To specify other root directories, list them as arguments on the
  61 command line.  It is an error if any of the root paths specified does
  62 not end with a known architecture.
  63 .SH ENVIRONMENT VARIABLES
  64 .LP
  65 .B SRCTOP
  66 .RS 4
  67 The root of your workspace, which is the directory containing
  68 \fI.git\fP.
  69 .RE
  70 .LP
  71 .B SRC
  72 .RS 4
  73 The location of your ON source tree.  Defaults to
  74 \fI$SRCTOP/usr/src/\fP if not specified.
  75 .RE
  76 .SH SEE ALSO
  77 .B nightly(1ONBLD).