Table Of Contents

Using the NI Compare Tool with Source Control Providers

Version:
Last Modified: September 19, 2017

A source control provider is a piece of third-party software that enables you to share files among multiple users, improve security and quality, and track changes to shared projects. You can use the NI Compare Tool to display the differences between the local copy of a selected file and the version in source control.

Before beginning this task, make sure the computer on which you are running the NI Compare Tool includes a source control provider.

Complete the following steps to configure a source control provider to use the NI Compare Tool as the default application to compare two versions of a file:

  1. Direct the source control provider to NI Compare.exe. By default, NI Compare.exe is installed in C:\Program Files\National Instruments\[Product]\NI Compare.exe.
  2. Enter arguments in the source control provider to configure NI Compare.exe to perform different operations. The following table lists available arguments.
    Argument Description
    -alias1 Changes the display name of the first file. You may consider changing the display name of the file if the filename is randomly generated. Specifying a meaningful display name helps you to keep track of the version of the file.
    -alias2 Changes the display name of the second file. You may consider changing the display name of the file if the filename is randomly generated. Specifying a meaningful display name helps you to keep track of the version of the file.
    -exclude Specifies the type of difference to ignore. Use commas to separate multiple types of differences.
    -report Generates a comparison report in HTML format that summarizes the differences.
    -usePreferences

    Specifies whether to use the default settings in the NI Compare Tool.

    The value for this argument can be only TRUE or FALSE. Specify a value of TRUE if you want to use user-defined settings. You can specify user-defined settings by selecting File»Preferences in the NI Compare Tool. Specify a value of FALSE if you want to use the default settings.

    If you do not use this argument, the NI Compare Tool uses the default settings.

    For example, you can use the following command to configure the source control provider to use the NI Compare Tool.

    "C:\Program Files\National Instruments\LabVIEW NXG\NI Compare.exe" $1 $2 -alias1 TestFile -usePreferences true -exclude Diagram.Comments,Diagram.Visual.Position -report "C:\Users\lvadmin\Desktop\compare report.html"

    where

    • $1 and $2 are variables the source control provider defines for the paths to the files you want to compare.
    • -alias1 TestFile changes the display name of the first file to TestFile.
    • -usePreferences true uses user-defined settings in the NI Compare Tool.
    • -exclude Diagram.Comments,Diagram.Visual.Position configures the tool to not detect or display differences of comments on the diagram and node positions on the diagram.
    • -report "C:\Users\lvadmin\Desktop\compare report.html" generates an HTML comparison report and saves the report to C:\Users\lvadmin\Desktop.
  3. (Optional) Complete any remaining steps to configure the source control provider. For example, some source control providers allow you to specify comparison tools for particular file extensions. You can specify NI Compare.exe for files with the .gvi, .gmrd, and .gcdl extensions. Consult the documentation for the source control provider for more configuration information.

Recently Viewed Topics