[Insight-developers] Unified CVS commit tags
Andy Cedilnik
andy.cedilnik at kitware.com
Wed Oct 6 08:40:02 EDT 2004
Hi Jim,
For NEW, I would say Rev 1.1 + ENH -> NEW. The only reason for this tags
is to quickly look through the change logs. The NEW does not add any
information, since you see that it is a fresh commit.
All runtime issues with the code can be categorized into three
categories:
1. Code that is new and adds functionality
2. Code that improves performance
3. Code that fixes bug
First two are easy. The third one is problematic. If you use term FIX,
then you will notice that people will fix performance of algorithm and
use FIX. Or they will fix build problem and again use FIX.
BUG at least forces you to say, ok, are we fixing bug or build problem,
or just improving the code?
Andy
On Wed, 2004-10-06 at 08:28, Miller, James V (Research) wrote:
> I still like FIX: for algorithm changes that fix some sort of problem (wrong
> calculation, crash, etc.).
>
> I think NEW: would point out that this is the first checkin of a file, not
> for "new" subfeatures to existing code. The latter would be handled by ENH:
>
> If there is no NEW: what would I use when I check in a new file? ENH:?
>
>
> -----Original Message-----
> From: Andy Cedilnik [mailto:andy.cedilnik at kitware.com]
> Sent: Tuesday, October 05, 2004 6:03 PM
> To: Bill Lorensen
> Cc: Lorensen, William E (Research); Miller, James V (Research); 'Luis
> Ibanez'; Insight Developers List
> Subject: RE: [Insight-developers] Unified CVS commit tags
>
>
> Hi Bill,
>
> Exactly. So, BUG clearly refers to runtime problem, where as FIX can be
> just about anything.
>
> Andy
>
> On Tue, 2004-10-05 at 17:38, Bill Lorensen wrote:
> > I think COMP: handles compile time fixes.
> >
> > At 05:19 PM 10/5/2004, Andy Cedilnik wrote:
> > >Hi Bill,
> > >
> > >The problem with FIX is that it is not clear if it is compile time fix
> > >or run time fix.
> > >
> > >The NEW and ENH is pretty much the same thing. NEW does not actually add
> > >any more information.
> > >
> > > Andy
> > >
> > >On Tue, 2004-10-05 at 16:25, Lorensen, William E (Research) wrote:
> > > > I agree with Jim that FIX is better than BUG. NEW is also good. I
> sometimes
> > > > use PORT for portability issues, but that is not that big a deal.
> > > >
> > > >
> > > > -----Original Message-----
> > > > From: Miller, James V (Research) [mailto:millerjv at crd.ge.com]
> > > > Sent: Monday, October 04, 2004 11:10 AM
> > > > To: 'Luis Ibanez'
> > > > Cc: Insight Developers List
> > > > Subject: RE: [Insight-developers] Unified CVS commit tags
> > > >
> > > >
> > > > If BUG is what we already agreed upon, then most of my "fixes" have
> the
> > > > wrong comment line. I almost always use "FIX:"
> > > >
> > > > Should there be a "NEW: " tag to identify when something new is added
> > > > to the repository. If usually just do something like "First checkin"
> > > >
> > > > Jim
> > > >
> > > > -----Original Message-----
> > > > From: Luis Ibanez [mailto:luis.ibanez at kitware.com]
> > > > Sent: Monday, October 04, 2004 10:46 AM
> > > > To: Miller, James V (Research)
> > > > Cc: Insight Developers List
> > > > Subject: Re: [Insight-developers] Unified CVS commit tags
> > > >
> > > >
> > > >
> > > > Hi Jim,
> > > >
> > > > I personnaly agree with you in that "FIX" sounds
> > > > more positive than "BUG"...
> > > >
> > > > However, in the ITK Developers document, "BUG" is
> > > > the entry that we already agreed on.
> > > >
> > > > Insight/Documentation/
> > > > InsightDevelopersStart.doc
> > > > InsightDevelopersStart.pdf
> > > >
> > > >
> > > > In fact,
> > > > the only suggested tag that is new for ITK is "COMP".
> > > >
> > > > "COMP" reflects situations like the lack of "typename"
> > > > which is not exactly a bug, but where, a modification
> > > > of the code will make possible for it to compile in
> > > > specific platforms. The same situation happens with the
> > > > use of the StaticConstMacro that makes possible to
> > > > compile for Borland and VC 6.0.
> > > >
> > > >
> > > > Luis
> > > >
> > > >
> > > > ----------------------------------
> > > > Miller, James V (Research) wrote:
> > > >
> > > > > I prefer FIX: rather than BUG:
> > > > >
> > > > > I don't like commiting bugs. But I do like commiting fixes.
> > > > >
> > > > > COMP feels a little weird to me, but I can probably adapt.
> > > > >
> > > > >
> > > > >
> > > > > -----Original Message-----
> > > > > From: Luis Ibanez [mailto:luis.ibanez at kitware.com]
> > > > > Sent: Monday, October 04, 2004 1:31 AM
> > > > > To: Insight Developers List
> > > > > Subject: [Insight-developers] Unified CVS commit tags
> > > > >
> > > > >
> > > > >
> > > > > We are considering unifying CVS commit tags among several projects
> > > > > (ITK, VTK, CMake, and ParaView) and we came up with the following
> list:
> > > > >
> > > > >
> > > > > BUG: a change made to fix a runtime issue (crash or incorrect
> results)
> > > > >
> > > > > COMP: a fix for a compilation issue, error or warning
> > > > >
> > > > > ENH: new functionality added to the project
> > > > >
> > > > > PERF: performance improvement
> > > > >
> > > > > STYLE: a change that doesn't impact the logic or execution of the
> code
> > > > >
> > > > >
> > > > > This list is not too far from what we have been using up to this
> point.
> > > > >
> > > > > Does anybody have any objection with adapting the cvs
> > > > > commit convention in ITK ?
> > > > >
> > > > >
> > > > > Thanks
> > > > >
> > > > >
> > > > > Luis
> > > > >
> > > > >
> > > > >
> > > > >
> > > > > _______________________________________________
> > > > > Insight-developers mailing list
> > > > > Insight-developers at itk.org
> > > > > http://www.itk.org/mailman/listinfo/insight-developers
> > > > > _______________________________________________
> > > > > Insight-developers mailing list
> > > > > Insight-developers at itk.org
> > > > > http://www.itk.org/mailman/listinfo/insight-developers
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > > > _______________________________________________
> > > > Insight-developers mailing list
> > > > Insight-developers at itk.org
> > > > http://www.itk.org/mailman/listinfo/insight-developers
> > > > _______________________________________________
> > > > Insight-developers mailing list
> > > > Insight-developers at itk.org
> > > > http://www.itk.org/mailman/listinfo/insight-developers
> > >--
> > > Andy Cedilnik
> > > Kitware Inc.
> > >
> > >_______________________________________________
> > >Insight-developers mailing list
> > >Insight-developers at itk.org
> > >http://www.itk.org/mailman/listinfo/insight-developers
--
Andy Cedilnik
Kitware Inc.
More information about the Insight-developers
mailing list