6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>

          --- old/usr/src/tools/findunref/findunref.1onbld
          +++ new/usr/src/tools/findunref/findunref.1onbld

   1    1  .\" CDDL HEADER START
   2    2  .\"
   3    3  .\" The contents of this file are subject to the terms of the
   4    4  .\" Common Development and Distribution License (the "License").
   5    5  .\" You may not use this file except in compliance with the License.
   6    6  .\"
   7    7  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8    8  .\" or http://www.opensolaris.org/os/licensing.
   9    9  .\" See the License for the specific language governing permissions
  10   10  .\" and limitations under the License.
  11   11  .\"

  12   12  .\" When distributing Covered Code, include this CDDL HEADER in each
  13   13  .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14   14  .\" If applicable, add the following below this CDDL HEADER, with the
  15   15  .\" fields enclosed by brackets "[]" replaced with your own identifying
  16   16  .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17   17  .\"
  18   18  .\" CDDL HEADER END
  19   19  .\"
  20   20  .\" Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  21   21  .\" Use is subject to license terms.
  22      -.TH findunref 1ONBLD "Oct 30, 2012"
       22 +.TH FINDUNREF 1ONBLD "Oct 30, 2012"
  23   23  .I findunref
  24   24  \- find unused files in a source tree
  25   25  .SH SYNOPSIS
  26   26  findunref [\fB-s\fP \fIsubtree\fP] [\fB-t\fP \fItstampfile\fP]
  27   27  [\fB-S\fP \fBhg\fP|\fBtw\fP|\fBgit\fP] \fIsrcroot\fP \fIexceptfile\fP
  28      -.LP
  29   28  .SH DESCRIPTION
  30      -.IX "OS-Net build tools" "findunref" "" "\fBfindunref\fP"
  31   29  .LP
  32   30  The findunref utility lists the files in a source tree which have not been
  33   31  accessed more recently than a particular timestamp file.  Although
  34   32  findunref may be used on its own, it is usually invoked by
  35   33  \fBnightly\fP(1ONBLD) to find files that are never referenced during a given
  36   34  build (see \fB-f\fP in \fBnightly\fP(1ONBLD)).
  37   35  .LP
  38   36  The root of the source tree to examine is specified by \fIsrcroot\fP.  To
  39   37  simplify comparing findunref output from different source trees, findunref
  40   38  outputs all filenames relative to \fIsrcroot\fP.

  41   39  .LP
  42   40  Some files in a source tree may be intentionally unreferenced (e.g.,
  43   41  documentation) or only referenced during specialized types of builds.
  44   42  Accordingly, \fIexceptfile\fP names a file containing a list of pathname
  45   43  globs that will be ignored by findunref.  Within \fIexceptfile\fP, any
  46   44  lines consisting solely of whitespace or starting with \fB#\fP will be
  47   45  ignored.  Directory globs may also be specified, which will cause any
  48   46  matching directories to be skipped entirely.  If no exceptions are
  49   47  desired, \fIexceptfile\fP can be \fB/dev/null\fP.
  50   48  .LP
  51   49  Depending on how findunref is invoked, it can either check all files, or
  52   50  limit its checks to files under control of a specific source code
  53   51  management (SCM) system.
  54   52  .LP
  55   53  To limit checks to files managed by Mercurial, the \fBhg\fP(1) utility must be
  56   54  present in \fB$PATH\fP and any relevant repositories must be located at or
  57   55  under \fIsrcroot\fP.  Nested Mercurial repositories are supported.
  58   56  .LP
  59   57  To limit checks to files managed by Git, the \fBgit\fP(1) utility must be
  60   58  present in \fB$PATH\fP and any relevant repositories must be located at or
  61   59  under \fIsrcroot\fP.  Nested Git repositories are \fInot\fR supported.
  62   60  .SH OPTIONS
  63   61  .TP 10
  64   62  .B -s \fIsubtree\fP
  65   63  Only look under \fIsubtree\fP for unreferenced files.  By default, all
  66   64  directories under \fIsrcroot\fP are examined.
  67   65  .TP 10
  68   66  .B -t \fItstampfile\fP
  69   67  Consider files older than \fItstampfile\fP to be unreferenced.
  70   68  By default, \fIsrcroot\fB/.build.tstamp\fR is used.
  71   69  .TP 10
  72   70  .B -S \fBhg\fP|\fBtw\fP|\fBgit\fP
  73   71  Only check files that are managed by the specified SCM.  To simplify
  74   72  interaction with \fBwhich_scm\fP(1ONBLD), the SCM names "mercurial" and
  75   73  "teamware" may also be specified for "hg" and "tw", respectively.
  76   74  By default, all files are checked.
  77   75  .SH SEE ALSO
  78   76  .LP
  79   77  \fBgit\fP(1),
  80   78  \fBhg\fP(1),
  81   79  \fBnightly\fP(1ONBLD),
  82   80  \fBwhich_scm\fP(1ONBLD)
  83   81  .SH NOTES
  84   82  Since many files are only used when building for a particular ISA (e.g.,
  85   83  Makefiles that are specific to x86 or SPARC), builds must be done on all
  86   84  applicable ISAs and the results merged.  For instance, if nightly builds
  87   85  (with \fB-f\fP) are done on both SPARC and x86, \fBusr/src\fP will be
  88   86  populated with a corresponding \fBunref-\fIisa\fB.out\fR file, which can
  89   87  be merged with \fBcomm\fP(1):
  90   88  .LP
  91   89  .nf
  92   90  comm -12 /path/to/unref-i386.out
  93   91           /path/to/unref-sparc.out > unref.out
  94   92  .fi
  95   93  .LP
  96   94  This merged file can then be compared against the gate's latest
  97   95  unreferenced file list (e.g. \fB/ws/onnv-gate/usr/src/unrefmaster.out\fP).
  98   96  .LP
  99   97  Different gates have different unreferenced file policies.  Any changes to
 100   98  \fIexceptfile\fP that would define new unreferenced file policies for a
 101   99  given gate must be cleared with the appropriate gatekeepers.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX