Re: Should this be mistype ?

Eric Lee wrote:
> Hi, I am checking out the best subversion client.
>
> But found a mistypo, but still not sure about that. Here a part of it.
>
> It is very common in Software Development for changes to be related to
> a specific bug or issue ID. Users of bug tracking systems (issue
> trackers) would like to associate the changes they make in Subversion
> with a specific ID in their issue tracker. Most issue trackers therefore
> provide a pre-commit hook script which parses the log message to find
> the bug ID with which the commit is associated. This is somewhat error
> prone since it relies on the user to write the log message properly so
> that the pre-commit hook script can parse it correctly.
>
>
> Should this be change from,
> Most issue trackers therefore provide a pre-commit hook script
>
> to,
> Most version control system therefore provide a pre-commit hook script

Thanks for reading our docs, you're part of a minority :)

Actually, the sentence in the docs is correct. We maybe should extend it
a little, because *both* version control systems and issue trackers
provide hook scripts.
Hook scripts for version control systems usually are used to check for
valid log messages, sometimes add something to a log message, send out
notifications (mail, rss, ...) and can do other stuff.

But what the docs talk about here are hook scripts for issue trackers.
Issue trackers provide such scripts which then are executed usually on
the repository server so they get notified of commits. The hook scripts
then analize the commit (most check the log message) and try to filter
out what issue that specific commit was associated with. For example, if
  I type in my commit log message something like "done this and that,
which *fixes issue #432*", then the issue tracker hook script could
recognize that this commit of mine was associated with issue #432.
The issue tracker then can create a link from the issue itself to that
commit, or add my commit log message to the issue. Some scripts even
check for "close issue #X" and then automatically close the issue.

I hope this clears things up a little bit.

Stefan

-- 
        ___
   oo  // \\      "De Chelonian Mobile"
  (_,\/ \_/ \     TortoiseSVN
    \ \_/_\_/>    The coolest Interface to (Sub)Version Control
    /_/   \_\     http://tortoisesvn.net