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

   1 .\" CDDL HEADER START
   2 .\"
   3 .\" The contents of this file are subject to the terms of the
   4 .\" Common Development and Distribution License (the "License").
   5 .\" You may not use this file except in compliance with the License.
   6 .\"
   7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" or http://www.opensolaris.org/os/licensing.
   9 .\" See the License for the specific language governing permissions
  10 .\" and limitations under the License.
  11 .\"
  12 .\" When distributing Covered Code, include this CDDL HEADER in each
  13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" If applicable, add the following below this CDDL HEADER, with the
  15 .\" fields enclosed by brackets "[]" replaced with your own identifying
  16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17 .\"
  18 .\" CDDL HEADER END
  19 .\"
  20 .\" Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
  21 .\" Use is subject to license terms.
  22 .\"
  23 .TH SCCSCHECK 1ONBLD "Apr 7, 2006"
  24 .SH NAME
  25 .I sccscheck
  26 \-
  27 .SH SYNOPSIS
  28 .B sccscheck
  29 filename
  30 .SH DESCRIPTION
  31 The standard solaris
  32 .I make(1)
  33 is SCCS-aware, automatically checking out files if they are out of
  34 date with respect to the SCCS file; however, this is of little value
  35 in the context of teamware and of no value if a non-SCCS SCM system is
  36 used, and can lead to hard-to-diagnose build failures  in the presence
  37 of recursive parallel make.
  38 The
  39 .I sccscheck
  40 script is used from the OS/Net Makefile.master file as a substitute
  41 for make(1)'s default handling of SCCS files; it generates errors
  42 preceded by "sccscheck: error", and warnings preceded by "sccscheck:
  43 warning".
  44
  45 By default an out-of-date source file is treated as a non-event, and the
  46 build continues onward; in most cases this will avoid unnecessary
  47 rebuilds of other targets depending on the out-of-date source file.
  48 .SH ENVIRONMENT
  49 If set to a non-empty string, SCCSCHECK_WARN will cause sccscheck to
  50 emit a verbose warning when an out-of-date source file is encountered;
  51 the build will continue but the resulting build logs will be large.
  52
  53 If set to a non-empty string, SCCSCHECK_FAIL will cause sccscheck
  54 to treat out-of-date source files as an error rather than a
  55 warning.
  56
  57 If both are set, behavior will be as if only SCCSCHECK_FAIL is set.
  58
  59
  60