Swarm 2015.1: User Guide (May 2015)

Swarm 2015.1: User Guide

May 2015

Copyright © 2013-2015 Perforce Software.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Perforce Software.

This product is subject to U.S. export control laws and regulations including, but not limited to, the U.S. Export Administration Regulations, the International Traffic in Arms Regulation requirements, and all applicable end-use, end-user and destination restrictions.

Licensee shall not permit, directly or indirectly, use of any Perforce technology in or by any U.S. embargoed country or otherwise in violation of any U.S. export control laws and regulations.

This distribution includes the following Perforce software; please consult the following for the license terms that apply to these pieces of software only:

  • P4PHP, the Perforce extension for PHP


    Location p4-bin/bin.platform


    Terms of Use: http://www.perforce.com/downloads/terms-use

This distribution also includes the following third party software; please consult the accompanying license file for the license terms that apply to that software only:

  • Arimo Font


    Location: public/vendor/arimo


    License: public/vendor/arimo/OFL.txt

  • Bootstrap


    Location: public/vendor/bootstrap


    License: public/vendor/bootstrap/LICENSE

  • Cousine Font


    Location: public/vendor/cousine


    License: public/vendor/cousine/OFL.txt

  • Git Logo


    Location: public/vendor/git


    License: public/vendor/git/CC-LICENSE.txt

  • Google Diff-Match-Patch


    Location: public/vendor/diff_match_patch


    License: public/vendor/diff_match_patch/COPYING

  • Google Code Prettify


    Location: public/vendor/prettify


    License: public/vendor/prettify/COPYING

  • jQuery


    Location: public/vendor/jquery


    License file: public/vendor/jquery/MIT-LICENSE.txt

  • jQuery Expander


    Location: public/vendor/jquery.expander


    License file: public/vendor/jquery.expander/license.txt

  • jQuery Sortable


    Location: public/vendor/jquery-sortable


    License file: public/vendor/jquery-sortable/LICENSE.txt

  • jQuery Timeago


    Location: public/vendor/jquery.timeago


    License file: public/vendor/jquery.timeago/MIT-LICENSE.txt

  • JsRender


    Location: public/vendor/jsrender


    License file: public/vendor/jsrender/MIT-LICENSE.txt

  • OpenSansEmoji


    Location: public/vendor/opensansemoji


    License file: public/vendor/opensansemoji/LICENSE.txt

  • ThreeJS


    Location: public/vendor/threejs


    License file: public/vendor/threejs/LICENSE

  • Zend Framework 2


    Location: library/Zend


    License file: library/Zend/LICENSE.txt


  • 1. Perforce Swarm
    • What's new in 2015.1
      • Major new functionality
      • Minor new functionality
      • Known limitations
  • 2. Quickstart
    • How do I start a code review?
      • Once a review has started
    • How do I contribute comments or code changes to a code review?
      • Commenting on a review
      • Commenting on a specific line in a file
      • Editing files in a review
      • Edit files in a review with Git Fusion
    • How do I get a local copy of the review's code for evaluation?
      • Determine the changelist containing the review's files
      • Using P4
      • Using P4V
      • Using Git Fusion
    • How can I fix 'not mergeable' errors in a review?
      • Resolve via P4
      • Resolve via P4V
    • How do I see a list of Git-created reviews?
    • How can I integrate my test suite to inform review acceptance or rejection?
      • Configuring Jenkins for Swarm integration
    • How can I automatically deploy code within a review?
    • How do I manage project branches?
      • Adding a branch
      • Editing a branch
      • Removing a branch
    • How do I change the logging level?
    • How do I check on the queue workers?
  • 3. Setting up
    • Swarm packages
      • Installation
      • Updating
      • Uninstall
      • Post-installation configuration
    • OVA configuration
      • VMWare OVA import
      • Oracle VirtualBox import
    • Runtime dependencies
      • Supported operating system platforms
      • Supported web browsers
      • Apache web server
      • PHP
      • Worker dependencies
      • Optional dependencies
      • Perforce Server requirements
      • Security-enhanced Linux (SELinux)
    • Initial installation
    • Apache configuration
    • PHP configuration
      • Alternative PHP Cache (APC) extension for PHP
      • Zend OPCache extension for PHP
      • ImageMagick (imagick) extension for PHP
    • Swarm configuration
      • Swarm configuration file
      • Optional additional Swarm configuration
    • Establish trigger token
    • Perforce configuration for Swarm
      • Using Perforce triggers to push events to Swarm
      • Hiding Swarm storage from regular users
    • Set up a recurring task to spawn workers
      • curl/wget verification
    • Upgrade instructions for 2014.4 to 2015.1
    • Upgrade instructions for 2014.3 to 2014.4
    • Upgrade instructions for 2014.2 to 2014.3
  • 4. Basics
    • Activity streams
    • Files
      • Downloading files as ZIP archive
      • Browsing deleted files and folders
      • File display
        • Text Files
        • Images
        • 3D models
        • Other file types
    • History
      • Range filter
      • File History
      • Remote depot history
    • Jobs
      • Adjusting Jobs columns
      • Job display
      • Adding jobs
      • Unlinking jobs
    • Changelists
      • Changelist Display
    • Diffs
      • Viewing a diff
    • Comments
      • Tasks
      • Comment features
        • Emoji
        • Links in comments
        • Comment attachments
        • Comment context
      • Commenting on a changelist or review
      • Commenting on a specific line in a file
      • Commenting on a file in a changelist or code review
      • Archiving comments
      • Restore comments
    • Users
      • Viewing users
    • Projects
      • Viewing a project
        • Reviews
        • Files
        • History
        • Jobs
    • Notifications
      • @mention notifications
      • Committed change notifications
        • Update Reviews with p4
        • Update Reviews with P4V
      • Review start notifications
    • Log in / Log out
      • To log in
      • When require_login is enabled
      • To log out
    • Notable minor features
      • Quick URLs
      • @mentions
      • JIRA integration
      • Avatars
      • Following
      • Time
      • Keyboard shortcuts
      • About Swarm
      • Custom error pages
      • Short links
      • Mobile browser compatibility
  • 5. Projects
    • Add a project
    • Edit a project
    • Membership
      • Add a member
      • Remove a member
    • Remove a project
  • 6. Code reviews
    • Models
      • Pre-commit model
      • Post-commit model
      • Git Fusion model
      • Internal representation
    • Review queues
      • Filtering open reviews
      • Filtering closed reviews
    • Review display
    • Activities
      • Start a review
      • Update a review
      • Fetch a review's files
        • Using P4
        • Using P4V
        • Using Git Fusion
      • Edit reviewers
    • Responsibility
      • Required reviewers
      • Add yourself as a reviewer
      • Remove yourself as a reviewer
    • Review workflow
      • Another developer reviews your code
      • You review another developer's code
    • States
      • State change restrictions with moderation
      • Required reviewers
      • State actions
  • 7. Integrations
    • JIRA
      • Enabling the JIRA module
    • LibreOffice
      • Limitations
      • Installation
  • 8. Administration
    • Archives configuration
    • Avatars
      • Disable avatar lookups
    • Backups
    • Changelist files limit
    • Client integration
    • Comment attachments
    • Commit credit
    • Commit timeout
    • Configuration overview
    • Email configuration
      • Sender
      • Transport
      • Recipients
      • Use BCC
      • Use Reply-To
      • Save all messages to disk
    • Emoji
    • Environment
      • Mode
      • Hostname
    • Excluding Users from Activity Streams
    • Ignored users for reviews
    • License
    • Locale
    • Logging
      • Web server logging
      • Perforce service logs
      • Swarm logs
      • Trigger Token Errors
      • Performance logging
    • Mainline branch identification
    • Notifications
    • OVA Management
      • Dependency Conflicts
    • Review keyword
    • Review enforcement
      • Group exclusion
    • Security
      • Require login
      • Prevent login
      • Sessions
      • Disable commit
      • Restricted Changes
      • Limit adding projects to administrators
      • Limit adding projects to members of specific groups
      • IP address-based protections emulation
        • Known limitations
      • Disable system info
      • HTTP client options
      • Strict HTTPS
      • Apache security
      • PHP security
    • Short links
    • System Information
      • Log
      • PHP Info
    • Unapprove modified reviews
    • Uninstall Swarm
      • Background
      • Uninstall steps
    • Workers
      • Worker status
      • Manually start workers
      • Manually restart workers
      • Worker configuration
  • 9. Extending Swarm
    • Resources
      • jQuery
      • JavaScript Resources
      • PHP Resources
      • Zend Framework 2 Resources
    • Development mode
      • To enable development mode
      • To disable development mode
    • RESTful interfaces
      • Creating events in the activity feed
      • Setting the test status for a code review
      • Web services
    • Modules
      • Influence activity events, emails, etc.
      • Templates
      • View helpers
        • Set options on existing helpers
        • Register new helpers
    • Example linkify module
    • Example email module
    • CSS & JavaScript
      • Sample JavaScript extension
      • Sample CSS customization
  • 10. Swarm API
    • API Endpoints
      • Activity : Swarm Activity List
        • POST /api/v1.1/activity
          • Description
          • Parameters
          • Example of a successful response
      • Index : Basic API controller providing a simple version action
        • GET /api/v1.1/version
          • Description
          • Example of a successful response
      • Projects : Swarm Projects
        • GET /api/v1.1/projects/
          • Description
          • Parameters
          • Example of a successful response
      • Reviews : Swarm Reviews
        • GET /api/v1.1/reviews/{id}
          • Description
          • Parameters
          • Example of a successful response
          • Example of a failure response
        • POST /api/v1.1/reviews/
          • Description
          • Parameters
          • Example of a successful response
        • POST /api/v1.1/reviews/{id}/changes/
          • Description
          • Parameters
          • Example of a successful response
        • GET /api/v1.1/reviews/
          • Description
          • Parameters
          • Examples of successful responses
  • A. Contact Perforce
  • B. Glossary
Hide partial matches
Highlight matches
0 matching pages
    Next
    Perforce Swarm