$log$ / Keyword Substitution / Expansion Check-In Policy (TFS - LogSubstPol)

New Post: Global installation

wensveen — Wed, 13 Jan 2010 16:57:13 GMT

Hi,

Thanks for this wonderful project!

Is there a way to install the policy globally, for all TFS projects? That would save me a lot of work.

Thanks,
Matthijs Wensveen

Commented Issue: Case Insensitive Keywords [5184]

wheeley — Wed, 13 Jan 2010 00:00:54 GMT

You need to find a method to allow keywords of mixed case. For example, you require the log keyword to be all lowercase when the user could use Title Case or be all uppercase.

Wheeley
Comments: ** Comment from web user: wheeley **

Thanks for applying some of it. But you still have issues with other keywords. I work with many developers on a project and even though we are forcing our developers to use consistent header comments, the keywords sometimes get adding incorrectly my new people. So sometimes it is $Revision$, other times it's $revision$ and yet other times its $REVISION$. I was trying to create a generic method of finding all the keywords possibilities at once. I see why it is slow. So another method you could try is create a second buffer in lowercase that you use to scan with and then alter both buffers at once and only write out the original. As to your question "Also I have not fully understood what you have done with replacing _CR/_LF... what was the intention behind this?", I was trying to use the correct encoding to test with. But you can't compare a byte to a byte array. And since "\n" & "\r" always convert to a single byte array I was just accessing the array directly to accomplish encoding specific testing.

Wheeley

Patch Applied: #4900

jkalmbach — Tue, 12 Jan 2010 21:19:35 GMT

jkalmbach has applied patch #4900.

Comment:
Thanks for your patch! I have applied it partly...

Just some comments:
Your cade has a very bad side-effect: it is very slow, because in IndexOf, you convert the *whole* buffer into an string and the search it... this is very bad... I will try to implement the lowe/upercase compare conversion more efficient..
Also, converting to lower/upercase is normally not a good idea... better is to compare with the *correct* sort-keys (but which is more difficult)...
Also I have not fully understood what you have done with replacing _CR/_LF... what was teh intention behind this?

But I have implemeted a solution for several log-keywords... take a look at the current source!
http://logsubstpol.codeplex.com/SourceControl/list/changesets

Source code checked in, #40282

jkalmbach — Tue, 12 Jan 2010 21:18:41 GMT

Resetting _CR/_LF for every "Evaluate" (because every file can has its own encoding)

Source code checked in, #40281

jkalmbach — Tue, 12 Jan 2010 21:12:02 GMT

- Added support for multiple $log$ keywords (currently support for $log$, $Log$ and §LOG$) - Translated some comment from german to english - Added some more test-cases / corrected some test-cases Thanks to wheely for his patch 100889...

Source code checked in, #40279

jkalmbach — Tue, 12 Jan 2010 20:20:19 GMT

Test-Cases corrected (missing "Space" at end of comment

New Post: Great Project

wheeley — Mon, 11 Jan 2010 23:34:26 GMT

Keep up the good work on this. This project is greatly appreciated. It helped my company solve a migration issue we were having.

Don't stop working on this!!!!

Wheeley

Patch Uploaded: #4900

wheeley — Mon, 11 Jan 2010 22:55:28 GMT

wheeley has uploaded a patch.

Description:
This patch adds case insensitivity to all keyword expansion tests. This way your code could have either $log$ or $Log$ or $LOG$ and all will be expanded.

Commented Issue: Case Insensitive Keywords [5184]

wheeley — Mon, 11 Jan 2010 02:33:24 GMT

I think I have a fix for this. Please changes in zip file. I believe I have all the encoding todo's fixed also.

Created Issue: Case Insensitive Keywords [5184]

wheeley — Sun, 10 Jan 2010 23:42:18 GMT

You need to find a method to allow keywords of mixed case. For example, you require the log keyword to be all lowercase when the user could use Title Case or be all uppercase.

Wheeley

Updated Release: LogSubstPol_v1.0.0.3 (Jan 10, 2010)

jkalmbach — Sun, 10 Jan 2010 10:00:08 GMT

LogSubstPol is a TFS check-in policy which insertes the check-in comments and other keywords into your source code, so you can keep track of the changes even if you are not connected to TFS.
It can be compared with the $log$ (and other) substitition in any other CVS systems.

This release has full support for other keywords like: $Author$, $Source$, $Date$, $Id$, $Header$, $RCSFile$, $PrevRevision$, $Revision$

This release fixed a small bug, if the substitution reduces the file size. Thanks to wheeley!

Released: LogSubstPol_v1.0.0.3 (Jan 10, 2010)

Sun, 10 Jan 2010 10:00:08 GMT

Updated Wiki: Home

jkalmbach — Sun, 10 Jan 2010 09:58:45 GMT

Project Description
LogSubstPol is a TFS check-in policy which insertes the check-in comments and other keywords into your source code, so you can keep track of the changes even if you are not connected to TFS.
It can be compared with the $log$ (and other) substitition in any other CVS systems.

Download: http://logsubstpol.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=38516
Example:

It will replace the $log$ line with very freely configurable lines which contains the comment from the Check-In dialog.
Keyword expansion for $Author$, $Source$, $Date$, $Id$, $Header$, $RCSFile$, $PrevRevision$, $Revision$ is also available.

You can use this editor to configure the $log$ lines (normally, you do not need to change anything):

Full documentation is available here: LogSubstPol_v1.0.0.3.pdf

If you like it you can also Donate to this project:

Quick Install

Install the plugin

Choose one of the following two topics:

Manual installation (easy)

Execute “Install\Install.cmd” on each TFS client computer. This will install the check-in policy in the users-context.

With TFS Power Tools (more complicated but better)

Install “TFS Power Tools” on every TFS client computer. Create a TFS folder “$/{Project}/TeamProjectConfig/CheckinPolicies” and add and check-in the “LogSubstPol.dll” file into this directory. Go to “Team Explorer|{Project}|Team members|Right-click|Personal settings…” and check “Install downloaded custom components” and uncheck “verify strong names before installing components”. Press “Download Now” and press Ok”.

Optional: Install a common configuration file

For better consistency regarding the $log$ entries, you should use a project-wide configuration file. This configuration file must be stored in the folder “$/{Project}/TeamProjectConfig/CheckinPolicies” with the name “LogSubstPolSetting.xml”. Various sample configuration file are available in the “example” folder. Please check-in one of these files.

If no file is checked-in, the local configuration will be used.

Activate the check-in policy

You must once activate this policy for each TFS project. Open Visual Studio and go to “Team Explorer|Right click on {Project}|Team Projects Settings|Source Control…|Check-In Policies” and select “Log Substitution Policy: Inserts Comments on Check-In” and click on “activate”.
Optional you can now change the settings for this check-in policy.

Source code checked in, #40208

jkalmbach — Sun, 10 Jan 2010 09:58:27 GMT

PDF auf v1.0.0.3

Source code checked in, #40207

jkalmbach — Sun, 10 Jan 2010 09:56:32 GMT

Version v.1.0.0.3 added

Updated Wiki: Home

jkalmbach — Sun, 10 Jan 2010 09:52:20 GMT

Quick Install

Install the plugin

Choose one of the following two topics:

Manual installation (easy)

Execute “Install\Install.cmd” on each TFS client computer. This will install the check-in policy in the users-context.

With TFS Power Tools (more complicated but better)

Optional: Install a common configuration file

Activate the check-in policy

Patch Applied: #4879

jkalmbach — Sun, 10 Jan 2010 09:50:56 GMT

jkalmbach has applied patch #4879.

Comment:
Thanks for submitting this patch! I applied it and a new release is now available (v1.0.0.3)! Thanks!

Created Release: LogSubstPol_v1.0.0.3 (Jan 10, 2010)

jkalmbach — Sun, 10 Jan 2010 09:49:29 GMT

Source code checked in, #40206

jkalmbach — Sun, 10 Jan 2010 09:43:48 GMT

Release 1.0.0.3

Source code checked in, #40205

jkalmbach — Sun, 10 Jan 2010 09:39:12 GMT

Prepared fro new revision