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/scripts/jstyle.1onbld
          +++ new/usr/src/tools/scripts/jstyle.1onbld

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

  13   13  .\" and limitations under the License.
  14   14  .\"
  15   15  .\" When distributing Covered Code, include this CDDL HEADER in each
  16   16  .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  17   17  .\" If applicable, add the following below this CDDL HEADER, with the
  18   18  .\" fields enclosed by brackets "[]" replaced with your own identifying
  19   19  .\" information: Portions Copyright [yyyy] [name of copyright owner]
  20   20  .\"
  21   21  .\" CDDL HEADER END
  22   22  .\"
  23      -.TH jstyle 1ONBLD "22 November 2005"
       23 +.TH JSTYLE 1ONBLD "Nov 22, 2005"
  24   24  .SH NAME
  25   25  .I jstyle
  26   26  \- check for some common stylistic errors in Java source files
  27   27  .SH SYNOPSIS
  28   28  \fBjstyle [-chptvC] [file...]\fP
  29      -.LP
  30   29  .SH DESCRIPTION
  31      -.IX "OS-Net build tools" "jstyle" "" "\fBjstyle\fP"
  32   30  .LP
  33   31  .B jstyle
  34   32  inspects Java source files (*.java) for common stylistic errors.  It
  35   33  is similar to
  36   34  .BR cstyle (1ONBLD)
  37   35  in that it attempts to check for the style
  38   36  documented in \fI/shared/ON/general_docs/cstyle.ms.pdf\fP, although by
  39   37  necessity is modified to work with Java-specific constructs.  Note that
  40   38  there is much in that document that
  41   39  .I cannot
  42   40  be checked for; just because your code is
  43   41  .BR jstyle (1ONBLD)
  44   42  clean does not
  45   43  mean that you've followed Sun's Java style.  \fICaveat emptor\fP.
  46      -.LP
  47   44  .SH OPTIONS
  48   45  .LP
  49   46  The following options are supported:
  50   47  .TP 4
  51   48  .B \-c
  52   49  Check continuation line indentation inside of functions.  Sun's C style
  53   50  states that all statements must be indented to an appropriate tab stop,
  54   51  and any continuation lines after them must be indented \fIexactly\fP four
  55   52  spaces from the start line.  This option enables a series of checks
  56   53  designed to find contination line problems within functions only.
  57      -.LP
  58   54  .TP 4
  59   55  .B \-h
  60   56  Performs heuristic checks that are sometimes wrong.  Not generally used.
  61      -.LP
  62   57  .TP 4
  63   58  .B \-p
  64   59  Performs some of the more picky checks.  You should generally use this.
  65      -.LP
  66      -.LP
  67   60  .TP 4
  68   61  .B \-t
  69   62  Insists on indentation with tabs.  Because of the depth of nested blocks
  70   63  that Java requires, and the commonality of long identifiers, tab
  71   64  indentation in Java code is not always useful, assuming that tabs are fixed
  72   65  at eight columns and that maximum line length is fixed at eighty columns,
  73   66  so this option is not on by default.  If you choose to consider tabs to be
  74   67  four columns wide (not acceptable for ON), or are writing simple enough
  75   68  code that the nesting is not very deep, this option might be useful.
  76   69  Otherwise, avoid it.
  77      -.LP
  78   70  .TP 4
  79   71  .B \-v
  80   72  Verbose output; includes the text of the line of error.
  81      -.LP
  82   73  .TP 4
  83   74  .B \-C
  84   75  Ignore errors in header comments (i.e., block comments starting in the
  85   76  first column).  Not generally used.
  86      -.LP
  87      -.LP
  88   77  .SH NOTES
  89   78  .LP
  90   79  The jstyle rule for the OS/Net consolidation is that all new files must
  91   80  be
  92   81  .B -p
  93   82  clean.  For existing files, the following invocations are
  94   83  run against both the old and new files:
  95      -.LP
  96   84  .TP 4
  97   85  .B "jstyle file"
  98      -.LP
  99   86  .TP 4
 100   87  .B "jstyle -p file"
 101   88  .LP
 102   89  If the old file gave no errors for one of the invocations, the new file
 103   90  must also give no errors.  This way, files cannot become unclean.
 104      -.LP
 105   91  .SH BUGS
 106   92  .LP
 107   93  .BR jstyle (1ONBLD)
 108   94  cannot disambiguate Java generic type parameters or
 109   95  arguments that span multiple lines from relational operators.  For example:
 110   96  .RS 4
 111   97  .HP 4
 112   98  private class Foo<A extends Bar,
 113   99  .br
 114  100  B extends Bar> { ...
 115  101  .RE
 116  102  .LP
 117  103  is flagged as two lines with missing spaces around relational operators.
    

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX