OpenSolaris

You are not signed in. Sign in or register.

heads-up: jstyle updates

Date: Thu, 15 Dec 2005 16:08:40 -0800
From: Danek Duvall <danek dot duvall at sun dot com>
To: onnv-gate at onnv dot eng dot sun dot com
Subject: heads-up: jstyle updates

[ Oops.  Re-sending to an un-fatfingered address. ]

If you never touch java code, then you can ignore this message.  For those
that do ...

With the putback of

    6241780 jstyle doesn't understand Java 5 generics
    6354506 jstyle needs to understand assert and throw are keywords
    6354513 jstyle can't handle // followed by non-space in a comment
    6354517 jstyle doesn't reset line count after each file
    6354581 jstyle wants to be a real perl script
    6354591 jstyle wants a man page
    6358257 jstyle should always turn on -s

jstyle has been improved to understand a few Java constructs that it had
not previously -- generics, annotations, and a couple of keywords that had
simply been missed in the past.

In addition, there are a handful of several basic cleanups, as well as the
addition of a man page.

What may surprise people working on java code, though, is the new
whitespace handling.  Previously, whitespace was treated as a separate
class of problems, and you had to use -s to see those problems.  No longer.
-s is on by default (and cannot be turned off).  In addition, comment
handling has been improved and may find more problems than before (though
in many cases, false positives in comments have been removed, and error
messages improved).

You may see extra noise with the new tool, whether used alone or through wx
nits or wx pbchk, both of which run jstyle.  If the complaint is correct,
please fix your code before you put back, just as you would with cstyle.
The gate rules for jstyle cleanliness are the same as for cstyle:

  - if you are touching a file that is already jstyle dirty, you are
    strongly encouraged to make it jstyle clean (we have no old AT&T java
    code that would be exempt, sorry)

  - if you are creating a new file or touching a file that is jstyle clean,
    it must be clean when you put back.

The new jstyle will be available in /ws/onnv-tools around midnight
(Pacific) tonight, along with the SUNWonbld package that delivers it if you
want to install it locally.  Please be sure to start using the new tool as
soon as you can.

In case of false positives, negatives, or expectations, please file a bug:

    solaris/consolidation/os-net-tools

Thanks,
Danek