Nicolas Williams wrote:
> On Thu, Mar 13, 2008 at 07:37:47AM -0700, David.Comay at Sun.COM wrote:
>>> BTW, is there a need to include ARC case number in the comments when it is
>>> already included in the bug synopsis ?
>> In SFW, putting the ARC case(s) in the comments is optional but in
>> other consolidations such as ON it's a requirement. I would recommend
>> including the relevant cases; and personally, I'm not a fan of bug
>> synopsis of the form
>>
>> 1234567 Implement XYARC 2008/03/13
>>
>> Rather, the synopsis should be descriptive such as
>>
>> 1234567 Provide DTrace probes for Erlang
>
> My wx active file has this as the comment for all files but
> install.subr:
>
> PSARC/2008/120 SQLite3.x
> 6665195 integrate SQLite3 into SFWNV (PSARC/2008/120)
>
> The synopsis for 6665195 is almost of the form you prefer, but for the
> parenthetical reference to the ARC case. If you'd like I can remove
> that from the synopsis; just say the word and it's done :)
If it matters, I agree with David - I'd rather the synopsis be as
descriptive as it can be in the limited space, or at least funny,
instead of being cryptic. I don't really care if the arc case is listed
too, but I do really dislike things like 'into SFWNV' because to me
it doesn't matter which consolidation, just that it's in Solaris. I can
either read the bug itself to find out where it went or search for it
in other places.
I personally don't care if you also have the ARC case in the delta
comment, but I don't want a novel there either. That's what the bug,
ARC info, and/or code comments are for :)
Mike
