OSDN Git Service

Add Document from TortoiseSVN 15285
[tortoisegit/TortoiseGitJp.git] / doc / AutolistDoc.txt
1 As of revision 2659, TSVN now can parse all the files listed and checked\r
2 in the commit dialog for words to use in the autocompletion list. This\r
3 is a very handy feature when writing log messages since it helps you\r
4 refer to changed methods, class names, ...\r
5 \r
6 The parsing of the files is done with regexes, and those regexes are\r
7 kept in {ProgramFiles}\TortoiseSVN\bin in autolist.txt. In our source\r
8 tree, that file lives at trunk/src/TortoiseSVNSetup/include/autolist.txt\r
9 \r
10 The installed file gets replaced whenever TSVN is upgraded (because bad\r
11 regexes can cause the commit dialog to crash), so anything you add there\r
12 will be lost on upgrade.\r
13 \r
14 Versions of TSVN later than 1.4 look for an additional file at\r
15 %APPDATA%\TortoiseSVN\autolist.txt, which is where you can put user-\r
16 defined regexes in addition to the standard ones.\r
17 \r
18 So here's how you can help:\r
19 - find a filetype/programming language you know well\r
20 - decide what of a typical file of that type you'd want in the\r
21   autocompletion list. Usually, you'd want method/function names,\r
22   class names, interface names. But maybe not variable names since\r
23   then the autocompletion list could get just too big!\r
24 - write a regex to parse for those strings\r
25 - test your regex on as many files you can find\r
26 - improve the regex and test again.\r
27 - test the whole thing with TSVN directly\r
28 - send us your regex string with the filetype you want it to apply to,\r
29   and maybe some testfiles too.\r
30 \r
31 To help you with this task, there's a little tool to test your regex\r
32 strings on files located here:\r
33 http://tortoisesvn.tigris.org/files/documents/406/20668/RegExpTest.exe\r
34 Just enter your regex string and drag the files you want to test it with\r
35 over the dialog. The parsed strings will be listed at the bottom of the\r
36 dialog.\r
37 \r
38 If you are unfamiliar with regular expressions, take a look at the online\r
39 documentation and tutorial at http://www.regular-expressions.info/\r
40 \r
41 Note that TSVN also uses regex groups and you can specify the flags to\r
42 use in the autolist.txt file like this:\r
43 (MULTILINE|NOCASE|GLOBAL) .txt, .pic = (regex-string)\r