docs

Author: SimonCropp

docs/mdsource/diff-tool.source.md

@@ -96,4 +96,6 @@ ReSharper | Options | Tools | Unit Testing | Test Runner
 
 ## Supported Tools:
 
+Tools location is automatically detected. If a tool installed in a custom location, it can be manually configured using an environment variable, that points to the executable. The environment variable format is `DiffEngine_{ToolName}`.
+
 include: diffTools

src/DiffEngine.Tests/DefinitionsTest.cs

@@ -120,6 +120,7 @@ static void AddTool(StreamWriter writer, Definition tool)
                             * Is MDI: {tool.IsMdi}
                             * Supports auto-refresh: {tool.AutoRefresh}
                             * Supports text files: {tool.SupportsText}
+                            * Environment variable for custom install location: `DiffEngine_{tool.Tool}`
                           """);
 
         if (tool.BinaryExtensions.Any())

src/DiffEngine.Tests/diffTools.include.md

@@ -10,6 +10,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_BeyondCompare`
   * Supported binaries: pdf, bmp, gif, ico, jpg, jpeg, png, tif, tiff, rtf
 
 #### Notes:
@@ -48,6 +49,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_DeltaWalker`
   * Supported binaries: jpg, jp2, j2k, png, gif, psd, tif, bmp, pct, pict, pic, ico, ppm, pgm, pbm, pnm, zip, jar, ear, tar, tgz, tbz2, gz, bz2, doc, docx, xls, xlsx, ppt, pdf, rtf, html, htm
 
 #### Notes:
@@ -76,6 +78,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Diffinity`
 
 #### Notes:
 
@@ -98,6 +101,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_DiffMerge`
 
 #### Notes:
 
@@ -134,6 +138,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_ExamDiff`
 
 #### Notes:
 
@@ -157,6 +162,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Guiffy`
   * Supported binaries: bmp, gif, jpeg, jpg, png, wbmp
 
 #### Notes:
@@ -190,6 +196,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Kaleidoscope`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tiff, tif
 
 #### OSX settings:
@@ -205,6 +212,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_KDiff3`
 
 #### Notes:
 
@@ -234,6 +242,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Neovim`
 
 #### Notes:
 
@@ -266,6 +275,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_P4Merge`
   * Supported binaries: bmp, gif, jpg, jpeg, png, pbm, pgm, ppm, tif, tiff, xbm, xpm
 
 #### Windows settings:
@@ -305,6 +315,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Rider`
 
 #### Notes:
 
@@ -350,6 +361,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TkDiff`
 
 #### OSX settings:
 
@@ -365,6 +377,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Environment variable for custom install location: `DiffEngine_TortoiseGitIDiff`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tif, tiff
 
 #### Windows settings:
@@ -383,6 +396,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TortoiseGitMerge`
 
 #### Windows settings:
 
@@ -400,6 +414,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Environment variable for custom install location: `DiffEngine_TortoiseIDiff`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tif, tiff
 
 #### Windows settings:
@@ -418,6 +433,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TortoiseMerge`
 
 #### Windows settings:
 
@@ -435,6 +451,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Vim`
 
 #### Notes:
 
@@ -468,6 +485,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_WinMerge`
   * Supported binaries: bmp, cut, dds, exr, g3, gif, hdr, ico, iff, lbm, j2k, j2c, jng, jp2, jpg, jif, jpeg, jpe, jxr, wdp, hdp, koa, mng, pcd, pcx, pfm, pct, pict, pic, png, pbm, pgm, ppm, psd, ras, sgi, rgb, rgba, bw, tga, targa, tif, tiff, wap, wbmp, wbm, webp, xbm, xpm
 
 #### Notes:
@@ -498,6 +516,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_AraxisMerge`
   * Supported binaries: bmp, dib, emf, gif, jif, j2c, j2k, jp2, jpc, jpeg, jpg, jpx, pbm, pcx, pgm, png, ppm, ras, tif, tiff, tga, wmf
 
 #### Notes:
@@ -531,6 +550,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_CodeCompare`
 
 #### Notes:
 
@@ -552,6 +572,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Meld`
 
 #### Notes:
 
@@ -589,6 +610,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_SublimeMerge`
 
 #### Notes:
 
@@ -625,6 +647,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_VisualStudio`
 
 #### Windows settings:
 
@@ -651,6 +674,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_VisualStudioCode`
 
 #### Notes: