OpenSolaris

You are not signed in. Sign in or register.

heads up: wx now checks comments against bug database

Date: Thu, 3 Aug 2006 13:26:43 -0700
From: Danek Duvall <danek.duvall at sun dot com>
To: on-all at sun dot com, onnv-gate at onnv dot eng dot sun dot com
Subject: heads up: wx now checks comments against bug database

With my recent putback of

    6445267 wx should cross-check delta comments with bug database

wx will now cross check your bugid comments against the bug database
(through the monaco commandline interface).  This should reduce the number
of typos, cut-and-paste errors, and comment adornment that we've seen
(assuming, of course, that people are using wx pbchk as they should be).

The checks are done in all places where comment checking is done for bugs
(previously limited to consistency and format):

    wx pbcom
    wx bugs
    wx pbchk
    wx comchk
    wx putback
    wx rtichk

For bugs, pbcom, and putback, the lookup can be disabled (but you'll get a
warning) by passing the -N flag, which is useful in a situation where
connections to Monaco hang, or you simply can't wait the extra few seconds
it takes to do the lookup (about three seconds in Menlo Park).  Situations
where the monaco script is simply unavailable (such as when you're
disconnected from SWAN, or NFS client access to /net/monaco.sfbay is
unavailable) will warn without any need for the flag.  For example, with
"wx pbcom" you might get:

    % /tmp/wx pbcom
    Bug 3333333 is not in the database
    Synopsis of 6311077 is wrong:
      should be: Enabling ON compilation with Sun Studio 11 (Venus)
             is: Enabling ON compilation with Sun Studio 11 (Venus)(no space)
    Synopsis of 6452853 is wrong:
      should be: RFE: add bug arg to wx edit for automatic filling of comment
             is: eat my shorts

and with -N you would see

    % /tmp/wx pbcom -N
    Not performing bug synopsis check (be careful)
    3333333 some bogus bugid
    5016238 nightly should be more conservative in clobbering logs (just fine)
    6279148 bfu auto-upgrade
    6311077 Enabling ON compilation with Sun Studio 11 (Venus)(no space)
    6452853 eat my shorts

Note that this check won't complain about follow-up putback comments which
have a parenthesized comment after the bug synopsis.

The updated wx will be in /ws/onnv-tools later tonight, Pacific time.

Thanks,
Danek