|
The CodeCollaborator Visual Studio Add-in allows files or changelists (for those SCM systems that support them) to be submitted for review from within the Visual Studio Solution Explorer, when the Solution, or when one or more Projects or Folders or Files are selected.
Features
| • |
Integrates with the Solution Explorer in Visual Studio |
| • |
Creates or adds to reviews from locally modified files, or from changelists |
| • |
Integrates with the SCM system configured for the GUI Client |
Compatibility
Visual Studio 2005, 2008 and 2010.
Installation
Make sure the GUI Client is installed and configured for your CodeCollaborator server and SCM system. Then run the Visual Studio Add-in standalone installer, available here.
The Visual Studio Add-in installer does not update the PATH environment variable to include the installed application folder (which is unnecessary if installing to the same application folder as the GUI Client). If installing to a different location, make sure to change your path to include the installed location.
The Visual Studio Add-in requires the .NET 3.5 Framework. If it's not already installed on your system, the installer will prompt you to install the .NET framework first.
To uninstall, run the installer again, or use the Control Panel Add/Remove Programs applet.
Usage
The Visual Studio Add-in is invoked from the Solution Explorer. A right mouse button click on a file, project or solution will bring up the context menu where you can select to Review changes or Review changelists.
Selecting the CodeCollaborator - Review changes menu item will find modified files under the directory associated with the current Solution Explorer selection to be added to a new or existing review.
Selecting the CodeCollaborator - Review changelists menu item will allow changelists associated with your configured SCM system to be added to a new or existing review.
Limitations and Known Issues
No validation is done for installing the CodeCollaborator - Review changelists menu item - not all SCM systems support changelists..
The installer does not update the PATH to include the installed application folder.
Troubleshooting
The Visual Studio Add-in shells out to the GUI Client - if it is isn't already configured and working, the Visual Studio Add-in won't work. If you're experiencing issues with the Visual Studio Add-in, first verify the GUI Client works.
For us to look into an issue with Visual Studio Add-in, please enable debug logging and send us the resulting log file. Debug logging is enabled by editing the .config file for the Visual Studio Add-in and setting the Debug value to "1", i.e.:
<add key="Debug" value="1"/>
Both the .config file and the .log file reside in the "Smart Bear\Visual Studio Addin" subdirectory under the Common Application Data Folder, which, depending on your Windows platform, is typically one of these directories:
"%ALLUSERSPROFILE%\SmartBear Software\Visual Studio Addin" on Windows 7 and Vista, or
"%ALLUSERSPROFILE%\Application Data\SmartBear Software\Visual Studio Addin" on Windows XP
Note that the files in this directory do not have general user write permission under Vista and Windows 7. To modify the .config file, either run your editor with administrator privileges, or run the Visual Studio Add-in configuration utility with the "debug" command:
CcollabAddinConfig debug
Then restart Visual Studio, reproduce the issue, close Visual Studio, and find and send the debug log file and problem description to support@smartbear.com. The Visual Studio Add-in configuration utility also has a "nodebug" command to turn off debug logging.
We also welcome any suggestions about the current implementation - usability, appearance, functionality or other feedback that would help improve the Visual Studio Add-in.
To submit problem reports or suggestions, open Add/Remove Programs from the Control Panel and select Support Information under Visual Studio Add-in. Submit the displayed version number along with your description of the issue.
|