Changes between Version 45 and Version 46 of CodeTagsPlugin


Ignore:
Timestamp:
Apr 12, 2017, 9:55:53 PM (7 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • CodeTagsPlugin

    v45 v46  
    22
    33= A plugin for displaying code tags (`XXX`, `FIXME`, `TODO`, etc.)
    4 
    5 {{{#!box warning
    6 **Notice:** This plugin used to be hosted externally and the source code is no longer reachable.
    7 }}}
    84
    95== Description
    … …  
    1612See [http://c2.com/cgi/wiki?FixmeComment FixmeComment].
    1713
    18 You need a subdirectory named `cache` that's writeable by your Trac to make this work. This takes some time in the first time used. Also don't forget to grant the `CODETAGS_VIEW` permission.
     14You need a subdirectory named `cache` that is writeable by your Trac to make this work. This takes some time the first it is used. Also don't forget to grant the `CODETAGS_VIEW` permission to your users.
    1915
    20 == Download / Source
     16== Bugs
    2117
    22 The latest CodeTagsPlugin release is [http://git.mortis.eu/git/codetags.git/snapshot/0.3.tar.gz codetags-0.3.tar.gz].
     18Existing bugs and feature requests for CodeTagsPlugin are
     19[report:9?COMPONENT=CodeTagsPlugin here].
    2320
    24 == Bugs / Known issues
     21If you have any issues, create a
     22[/newticket?component=CodeTagsPlugin new ticket].
    2523
    26  * When moving/deleting files with TODO tags in them, they will not disappear from the list
    27   * I've tested this and it works fine for me - rjollos 2009-08-03.
    28    * I am seeing this running Trac 0.12dev-r8983 and codetags-0.2 - aaron@irontickets.com
    29     * Running trac 0.11 (debian repo) I see this issue in codetags-0.2 - dagherad_at_gmail_dot_com (27th January 2010)
    30      * Fixed as of [http://git.mortis.eu/git/codetags.git/commit/dbae3295c4bf96313f673f01e2e1af8e3b632ba3 codetags-0.2_20100627142125]
     24[[TicketQuery(component=CodeTagsPlugin&group=type,format=progress)]]
    3125
    32  * Under 0.12 stable we got a error ''"!AttributeError: '!NoneType' object has no attribute 'youngest_rev'"'', the patch [attachment:CodeTags-0.12-get_repository.patch] fixes this problem. All Repository request should use !RepositoryManager as described in http://trac.edgewall.org/wiki/TracDev/ApiChanges/0.12
    33   * Should be fixed with commit [http://git.mortis.eu/git/codetags.git/commit/0b0baaaa962155b445702fa7ae37e1078d4a3361 0b0baaa], as it uses the Environment's backwards-compatibility API correctly.
    34  * Does not handle multiple repositories well
    35    * if no default set, `get_repository(None)` will return `None`
    36    * Even if a default is set, it will only parse this repository
    37    * Fixed by patch [attachment:basic_multirepo_support.patch]
     26Plugin does not handle multiple repositories well:
     27 * if no default set, `get_repository(None)` will return `None`
     28 * Even if a default is set, it will only parse this repository
     29 * Fixed by patch [attachment:basic_multirepo_support.patch]
    3830
    3931== Feature Requests
    … …  
    4739 * Allowing regex's for the [code-tags] fields would increase flexibility (scan_files, scan_folders, tags).
    4840
    49 == Installation / Configuration
     41== Download / Source
    5042
    51 To enable in the `trac.ini` file:
     43The latest CodeTagsPlugin release is [https://github.com/trac-hacks/codetags here].
     44
     45== Installation
     46
     47General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     48
     49To enable this plugin, add the following to your `trac.ini` file:
    5250{{{#!ini
    5351[components]
    5452codetags.* = enabled
    5553}}}
     54
     55== Configuration
    5656
    5757Additional configuration options can be added to the `trac.ini` file:
    … …  
    6464
    6565 {{{scan_files}}} :: allows you to define specific file types to scan (default: *)
    66  {{{scan_folders}}} :: specifies which directories within the repository to scan (default: *) [[br]]
    67  {{{exclude_folders}}} :: specifies directories that are subdirectories of {{{scan_folders}}} but don't need to be scanned [[br]]
    68  {{{exclude_files}}} :: specifies files that shouldn't be scanned even though they're included by scan_files [[br]]
    69  {{{tags}}} :: allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME) [[br]]
     66
     67 {{{scan_folders}}} :: specifies which directories within the repository to scan (default: *)
     68
     69 {{{exclude_folders}}} :: specifies directories that are subdirectories of {{{scan_folders}}} but don't need to be scanned
     70
     71 {{{exclude_files}}} :: specifies files that shouldn't be scanned even though they're included by scan_files
     72
     73 {{{tags}}} :: allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME)
    7074
    7175By default, this plugin doesn't ignore binary files. If you use svn/trac in a web-dev environment, this is a pain, since the tagger finds tags in files such as `.gif`.