[Insight-developers] Bug fixing procedures

[Luis Ibanez]

Hi Steve,

I agree with you in that the process is tedious when many
files are involved.

Changing from CVS to SVN in not in the short-term plans for ITK.

One option that comes to mind is that you could use the CVS diff
command with two dates, as a way of getting a list of all your
changes.

For example:

       cvs diff -D "2008 06 19" -D "2008 06 21"


There are probably other good options to get the summary of
changes without having to navigate the ViewCVS links one by one.

--

Regarding the other direction: from the change log to the bug entry:

You must mention the bug entry in the CVS commit command.

for example:

         cvs commit -m "BUG:7079 Fixing memory leak"

where 7079 is the bug number in the MANTIS bug tracker.

Note that our CVS commit filters require your commit messages
to contain one of the following tags:


     ENH: Enhancement
     BUG: #### bug fix
     STYLE: coding style fix
     COMP: fixing compilation errors or warnings


Any suggestions on how to do this better, are welcome.



    Regards,


        Luis


---------------------
Steve M. Robbins wrote:
> Hi Luis,
> 
> OK: I understand the utility of linking the bug report to the change
> set.  The procedure you describe is adequate when only 1 or 2 files
> are affected.  What do you do when a dozen or more files are changed?
> The procedure strikes me as too tedious -- hence error-prone -- to trust.
> 
> So have you considered moving to another system, say SVN, that 
> makes it easy to identify a changeset?
> 
> Also, what about the link in the other direction: from a change log
> message to the bug?
> 
> Regards,
> -Steve
> 
> 
> On Sat, Jun 21, 2008 at 10:38:44PM -0400, Luis Ibanez wrote:
> 
> 
>>Q2: The ViewCVS links can be taken from the following top link
>>    http://www.itk.org/cgi-bin/viewcvs.cgi/?root=Insight
>>
>>    This replicates the source tree of the repository.
>>    If you navigate through the subdirectories, you can
>>    get for example to Insight/Code/Common:
>>http://www.itk.org/cgi-bin/viewcvs.cgi/Code/Common/?root=Insight
>>
>>    and you could select a particular file, for example the itkMesh
>>http://www.itk.org/cgi-bin/viewcvs.cgi/Code/Common/itkMesh.h?root=Insight&view=log
>>
>>    and refer to the diffs between version 1.96 and version 1.95:
>>http://www.itk.org/cgi-bin/viewcvs.cgi/Code/Common/itkMesh.h?root=Insight&r1=1.95&r2=1.96
>>
>>     This is extremely helpful for other developers, who in five or
>>     six years will be looking back at your bug report and will be
>>     trying to figure out what changes were made and why.
> 
> 
>>-----------------------
>>Steve M. Robbins wrote:
> 
> 
>>>I've committed some trivial fixes to InsightApplications so that it
>>>builds with GCC 4.3 (c.f. 7225).  The procedure says "Link the CVS
>>>commit in the bug report":
>>>
>>>    *  Go to the bug report
>>>          o Insert as comment the WebCVS link to the commit.
>>>          o http://www.itk.org/cgi-bin/viewcvs.cgi/?cvsroot=Insight 
>>>
>>>
>>>Q2. What is "the WebCVS link" of the commit?
> 
>