Documentation | 2025.1

# Tag processor

Including a work-in-progress tag (#wip by default) in a pending changelist tells Swarm not to process the changelist when you update files in the shelf. This means that if the changelist already has a review that review will not be updated. If it doesn't have a review, a new review will not be created. For information on using the work-in-progress tag, see Work-in-progress tag.

If you make a configuration change, Swarm will not use it until the configuration cache has been reloaded, this forces Swarm to use the new configuration. You must be an admin or super user to reload the Swarm config cache. Navigate to the User id dropdown menu, select System Information, click the Cache Info tab, and click the Reload Configuration button.

## wip tag configuration

The work-in-progress tag is configured in the tags section of the tag_processor block in the swarm_root/data/config.php file. It is enabled by default:

    <?php
        // this block should be a peer of 'p4'
        'tag_processor' => array(
            'tags' => array(
                'wip' => '/(^|\s)+#wip($|\s)+/i'
            ),
        ),

### Disabling the work-in-progress tag

You can disable the work-in-progress tag completely if you don't want anyone to use it.

To disable the work-in-progress tag, delete the content of the wip string in the swarm_root/data/config.php file so that it is empty ( ''):

    <?php
        // this block should be a peer of 'p4'
        'tag_processor' => array(
            'tags' => array(
                'wip' => ''
            ),
        ),

### Customizing the work-in-progress tag

By default, the work-in-progress tag is #wip, but you can change it to whatever you want to use. Swarm uses Perl Compatible Regular Expressions ( PCRE) to process the wip tag, ensure that your new tag can be processed by PCRE before changing it. If your wip tag cannot be processed by PCRE, Swarm might ignore the tag or stop working correctly.

For example, to change the work-in-progress tag to #noreview, update the tag processor wip configuration in the swarm_root/data/config.php file to:

    <?php
        // this block should be a peer of 'p4'
        'tag_processor' => array(
            'tags' => array(
                'wip' => '/(^|\s)+#noreview($|\s)+/i'
            ),
        ),

### Making the work-in-progress tag case sensitive

To make the work-in-progress tag case sensitive, delete the trailing i from the wip configuration in the swarm_root/data/config.php file:

    <?php
        // this block should be a peer of 'p4'
        'tag_processor' => array(
            'tags' => array(
                'wip' => '/(^|\s)+#wip($|\s)+/'
            ),
        ),

Your search for returned results