Changes between Version 17 and Version 18 of CodeTagsPlugin

Timestamp:

Dec 3, 2008, 12:23:12 AM (15 years ago)

Author:

Giel van Schijndel

Comment:

Remove (now unrequired) patches, requests for implemented features, document scan_folders; link to demo (developer.wz2100.net/codetags) and git repository; +0.11

CodeTagsPlugin

@@ -1 +1 @@
 = A plugin for displaying code tags (`XXX`, `FIXME`, `TODO`, etc.) =
-'''NOTE''': {{{The links below seem to be dead. A }}}[http://git.mortis.eu/codetags.git git repository]{{{ is available instead.}}}
 
-Blog posting [http://trac.pocoo.org/wiki/blog/2006/06/06/00.04 here], Demo [http://trac.pocoo.org/codetags here], [http://trac.pocoo.org/repos/sandbox/codetags-plugin/ SVN repository].
+Blog posting [http://trac.pocoo.org/wiki/blog/2006/06/06/00.04 here], Demo [http://developer.wz2100.net/codetags here], [http://git.mortis.eu/codetags.git git repository].
 Since I cannot find any documentation directly I just wanted to tell you people that you need a subdirectory named cache thats writeable by your trac to make this work. Oh and dont wonder that it takes so much time the first time used ;). Also don't forget to grant the CODETAGS_VIEW permission.
 
@@ -20 +19 @@
 {{{scan_files}}} allows you to define specific file types to scan (default: *) [[br]]
 {{{scan_folders}}} specifies which directories within the repository to scan (default: *) [[br]]
+{{{exclude_folders}}} specifies directories that are subdirectories of {{{scan_folders}}} but don't need to be scanned [[br]]
 {{{tags}}} allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME) [[br]]
 
@@ -26 +26 @@
 User submitted patch seems to work: http://trac.pocoo.org/attachment/ticket/109/diff.txt
 
-Given the configuration options, I feel that the above referenced patch is unneeded if you have configured properly.  On the other hand, there are legitimate uses for long strings of XXX's without them being a code tag.  A simple one line change in indexer.py would eliminate 99% of XXX tags that were unintentional by requiring them to end with a colon:
-
-{{{
-#!diff
-Index: indexer.py
-===================================================================
---- indexer.py  (revision 2368)
-+++ indexer.py  (working copy)
-@@ -27,7 +27,7 @@
-         
-         p = []
-         for word in self.tags:
--            p.append(re.escape(word))
-+            p.append(re.escape(word + ':'))
-         self.tag_re = re.compile(r'(%s)\:?\s*(.*?)\s*$' % '|'.join(p))
- 
-         cdir = os.path.join(os.path.abspath(env.path), 'cache', 'codetags')
-}}}
-
-I Think This Approach is better the Regex Matches TAG: AND TAG[SPACE].
-The Above Patch only Matches TAG:Word & TAG::Word and TAG:[SPACE]
-{{{
-#!diff
-Index: indexer.py
-===================================================================
---- indexer.py  (revision HEAD)
-+++ indexer.py  (working copy)
-@@ -28,5 +28,5 @@
-
-      for word in self.tags:
-             p.append(re.escape(word))
--        self.tag_re = re.compile(r'(%s)\:?\s*(.*?)\s*$' % '|'.join(p))
-+        self.tag_re = re.compile(r'(%s)[\:\s]+(.*?)\s*$' % '|'.join(p))
- 
-         cdir = os.path.join(os.path.abspath(env.path), 'cache', 'codetags')
-}}}
-
-= Word Boundaries Patch =
-If you don't want to match comment lines containing your tags as subwords (e.g. DEBUG contains BUG and would normally match), you can apply this patch to {{{indexer.py}}}:
-
-{{{
-#!diff
-30c30
-<             p.append(re.escape(word))
----
->             p.append(r'\b' + re.escape(word) + r'\b')
-}}}
+This patch is now most likely unnecessary though, because CodeTagsPlugin plugin now searches for word boundaries (regex '\b') at the edges of words.
 
 = Feature Request =
@@ -80 +34 @@
   * Choose display for only specified tags
   * Chose display for only specified path in repository
- * Additionally allow for blacklisting and/or patterns. E.g. we have plenty of BUG_FOOBAR constants that we obviously dont want in the list, so a blacklist for BUG_ but then still using all other BUG things would be nice.