Multiple File Check-In from IDE -- Problem with Comments

If you are having a problem using Vault, post a message here.

Moderator: SourceGear

Post Reply
montek
Posts: 107
Joined: Mon Jan 05, 2004 8:46 am

Multiple File Check-In from IDE -- Problem with Comments

Post by montek » Fri Apr 02, 2004 12:08 pm

Using Vault 2.0.1 and Visual Studio .NET 2003, we have detected a strange problem. I'm not sure how often this may have happened, but so far--at least anecdotally--it seems to be more than just this one time.

Someone uses VS's pending check-ins box. Three files are represented and all three are checked. One comment is typed into the comment box, and the files are checked in.

We always use the same "naming" convention when checking in multiple files related to our own internal issue tracking system, so each time a unique number is assigned. For instance, the comment might be "8242 - Fixed data bug."

Then if you go into the Vault and use the history tool to search comments for "8242" you will see all three files returned in the results (correct); however, only two of them have the actual comment available. The third is empty.

If you double-click on one of the files (to see the Vault transaction information), you'll see that all three files were checked in at the same time. None of the individual files have a comment at all (expected because they were checked in with a transaction), but there is a "Change Set Comment" (what I've been calling a transaction) with the correct comment.

Also, if you go view history on any of the three individual files, you will see the correct comment for two of them (the same two that had comments during the search) and NOTHING for the other one.

Not that I think it matters, but the two "correct" ones are both in the same directory (say /files/directory1/) and the other is in a similarly-leveled directory (say /files/directory2/).

dan
Posts: 2448
Joined: Wed Dec 17, 2003 5:03 pm
Location: SourceGear
Contact:

Post by dan » Fri Apr 02, 2004 2:43 pm

I'm not able to reproduce this, so something more subtle is happening.

Are you using 2.0? There was a bug previous to that that spaces would be valid comments in the IDE, and if you accidently put a space or CR in the comment box in the checkout dialog, it would use that as the comment for that file on checkin too, but of course it would look empty.

montek
Posts: 107
Joined: Mon Jan 05, 2004 8:46 am

Post by montek » Fri Apr 02, 2004 3:31 pm

dan wrote:I'm not able to reproduce this, so something more subtle is happening.

Are you using 2.0? There was a bug previous to that that spaces would be valid comments in the IDE, and if you accidently put a space or CR in the comment box in the checkout dialog, it would use that as the comment for that file on checkin too, but of course it would look empty.
I answered the version question in advance. I can't see how this could be that issue since it was only ONE comment....

dan
Posts: 2448
Joined: Wed Dec 17, 2003 5:03 pm
Location: SourceGear
Contact:

Post by dan » Fri Apr 02, 2004 3:56 pm


I answered the version question in advance. I can't see how this could be that issue since it was only ONE comment....
Oops - sorry about the version question.

Vault stores both "change set comments" and individual file comments, and when you search on "comments" it will search both. This allows you to put comments on each individual file change, and then also have an overall change set for the group of changes you are making.

History displayed in the History Explorer will first display individual file comments, and if none exist, it will display the change set comment. When you double click an item in the History Explorer, the Version Details shows everything that was checked in in the same change set, and shows both the change set comment at the top and the individual item comments for each file.

The only way to add individual file comments through the IDE is through the checkout dialog. Entering a comment in the pending changes pane will add that comment as a change set comment to Vault.

After playing with this some more, I think I've found the bug, and it is the a different version of the one from before. If when you check out a file from the IDE, if you accidently hit return when the checkout dialog comes up, it adds a return to the comment in the checkout box. Apparently, this is not stripped later, and taken as the individual item comment, but it shows as blank when displaying in history. This should be simple to fix.

austegard
Posts: 4
Joined: Fri Jan 02, 2004 4:28 pm
Contact:

Post by austegard » Tue Apr 27, 2004 8:22 am

I was going to request this as a feature, but if it is considered a bug and will be fixed, that'd be even better:

When checking out a file (which frequently happens as the result of starting to type in a checked in file) frequently a check out comment gets entered accidentally. When using the $Log$ keyword expansion, the check out comment overrides the check in comment leading to blank or nonsense comments in the change log.

The feature I'd request is to have a repository option to turn off check out comments (similar to the one that requires check in comments). The bug fix would be to stop the behavior described above.

(Using Vault 2.01 (2137)

Thanks,
Oskar

dan
Posts: 2448
Joined: Wed Dec 17, 2003 5:03 pm
Location: SourceGear
Contact:

Post by dan » Tue Apr 27, 2004 12:46 pm

This was a bug that was fixed in 2.0.2. Would you still want the feature if the bug is fixed? :)

austegard
Posts: 4
Joined: Fri Jan 02, 2004 4:28 pm
Contact:

Post by austegard » Tue Apr 27, 2004 3:19 pm

Thanks - I'll have to upgrade to 2.0.2 then...

Yeah, the feature would still be nice - the more the merrier. But I can live without it.

Oskar

Post Reply