add DiffEngine.MaxInstances

Author: SimonCropp

docs/code-verus-machine-settings.md

@@ -0,0 +1,40 @@
+<!--
+GENERATED FILE - DO NOT EDIT
+This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
+Source File: /docs/mdsource/code-verus-machine-settings.source.md
+To change this file edit the source file and then run MarkdownSnippets.
+-->
+
+# Code versus machine level settings
+
+The approach to when a config setting is either a code based API or a machine level environment variable is driven by if the setting is a personal preference or shared.
+
+
+## Personal preferences
+
+Settings that are personal preferences ideally should
+
+ * Not be share with other people using the same code base.
+ * When running on the same machine, operate the same for different code bases that all use DiffEngine.
+ * Not apply to CI.
+
+Examples:
+
+ * [Custom order](diff-tool.order.md#custom-order) which depend on the tools a specific person has installed.
+ * [Disable launching](/#disable-for-a-machineprocess).
+ * [Max instances to launch](diff-tool.md#maxinstancestolaunch).
+
+
+## Shared preferences
+
+Settings that are shared ideally should
+
+ * Checked into the code base.
+ * Be share with other people using the same code base.
+ * When running on the same machine, not effect different code bases that all use DiffEngine.
+ * Apply to CI.
+
+Examples:
+
+ * [File type detection](/#file-type-detection).
+ * [Adding a share custom tool](/diff-tool.custom.md). A team may be comparing custom file types, and require a shared custom tool to verify that file.

docs/diff-tool.custom.md

@@ -23,7 +23,7 @@ var resolvedTool = DiffTools.AddTool(
  exePath: diffToolPath,
  binaryExtensions: new[] {"jpg"})!;
 ```
-<sup><a href='/src/Tests/DiffToolsTest.cs#L24-L35' title='File snippet `addtool` was extracted from'>snippet source</a> | <a href='#snippet-addtool' title='Navigate to start of snippet `addtool`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffToolsTest.cs#L23-L34' title='File snippet `addtool` was extracted from'>snippet source</a> | <a href='#snippet-addtool' title='Navigate to start of snippet `addtool`'>anchor</a></sup>
 <!-- endsnippet -->
 
 Add a tool based on existing resolved tool:
@@ -36,7 +36,7 @@ var resolvedTool = DiffTools.AddToolBasedOn(
  name: "MyCustomDiffTool",
  arguments: (temp, target) => $"\"custom args {temp}\" \"{target}\"");
 ```
-<sup><a href='/src/Tests/DiffToolsTest.cs#L65-L70' title='File snippet `addtoolbasedon` was extracted from'>snippet source</a> | <a href='#snippet-addtoolbasedon' title='Navigate to start of snippet `addtoolbasedon`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffToolsTest.cs#L64-L69' title='File snippet `addtoolbasedon` was extracted from'>snippet source</a> | <a href='#snippet-addtoolbasedon' title='Navigate to start of snippet `addtoolbasedon`'>anchor</a></sup>
 <!-- endsnippet -->
 
 
@@ -49,7 +49,7 @@ New tools are added to the top of the order, the last tool added will resolve be
 ```cs
 DiffRunner.Launch(tempFile, targetFile);
 ```
-<sup><a href='/src/Tests/DiffRunnerTests.cs#L21-L23' title='File snippet `diffrunnerlaunch` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerlaunch' title='Navigate to start of snippet `diffrunnerlaunch`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffRunnerTests.cs#L20-L22' title='File snippet `diffrunnerlaunch` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerlaunch' title='Navigate to start of snippet `diffrunnerlaunch`'>anchor</a></sup>
 <!-- endsnippet -->
 
 Alternatively the instance returned from `AddTool*` can be used to explicitly launch that tool.
@@ -64,7 +64,7 @@ var resolvedTool = DiffTools.AddToolBasedOn(
 
 DiffRunner.Launch(resolvedTool!, "PathToTempFile", "PathToTargetFile");
 ```
-<sup><a href='/src/Tests/DiffToolsTest.cs#L79-L86' title='File snippet `addtoolandlaunch` was extracted from'>snippet source</a> | <a href='#snippet-addtoolandlaunch' title='Navigate to start of snippet `addtoolandlaunch`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffToolsTest.cs#L78-L85' title='File snippet `addtoolandlaunch` was extracted from'>snippet source</a> | <a href='#snippet-addtoolandlaunch' title='Navigate to start of snippet `addtoolandlaunch`'>anchor</a></sup>
 <!-- endsnippet -->
 
 

docs/diff-tool.md

@@ -48,12 +48,20 @@ By default a maximum of 5 tool instances will be launched. This prevents a chang
 
 This value can be changed:
 
+
+### Using an environment variable
+
+Setting the `DiffEngine.MaxInstances` environment variable to the number of instances to launch.
+
+
+### Using code
+
 <!-- snippet: MaxInstancesToLaunch -->
 <a id='snippet-maxinstancestolaunch'/></a>
 ```cs
 DiffRunner.MaxInstancesToLaunch(10);
 ```
-<sup><a href='/src/Tests/DiffToolsTest.cs#L13-L17' title='File snippet `maxinstancestolaunch` was extracted from'>snippet source</a> | <a href='#snippet-maxinstancestolaunch' title='Navigate to start of snippet `maxinstancestolaunch`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffToolsTest.cs#L12-L16' title='File snippet `maxinstancestolaunch` was extracted from'>snippet source</a> | <a href='#snippet-maxinstancestolaunch' title='Navigate to start of snippet `maxinstancestolaunch`'>anchor</a></sup>
 <!-- endsnippet -->
 
 

docs/diff-tool.order.md

@@ -51,5 +51,5 @@ For example `VisualStudio,Meld` will result in VisualStudio then Meld then all o
 ```cs
 DiffTools.UseOrder(DiffTool.VisualStudio, DiffTool.AraxisMerge);
 ```
-<sup><a href='/src/Tests/DiffToolsTest.cs#L116-L118' title='File snippet `useorder` was extracted from'>snippet source</a> | <a href='#snippet-useorder' title='Navigate to start of snippet `useorder`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffToolsTest.cs#L115-L117' title='File snippet `useorder` was extracted from'>snippet source</a> | <a href='#snippet-useorder' title='Navigate to start of snippet `useorder`'>anchor</a></sup>
 <!-- endsnippet -->

docs/mdsource/code-verus-machine-settings.source.md

@@ -0,0 +1,33 @@
+# Code versus machine level settings
+
+The approach to when a config setting is either a code based API or a machine level environment variable is driven by if the setting is a personal preference or shared.
+
+
+## Personal preferences
+
+Settings that are personal preferences ideally should
+
+ * Not be share with other people using the same code base.
+ * When running on the same machine, operate the same for different code bases that all use DiffEngine.
+ * Not apply to CI.
+
+Examples:
+
+ * [Custom order](diff-tool.order.md#custom-order) which depend on the tools a specific person has installed.
+ * [Disable launching](/#disable-for-a-machineprocess).
+ * [Max instances to launch](diff-tool.md#maxinstancestolaunch).
+
+
+## Shared preferences
+
+Settings that are shared ideally should
+
+ * Checked into the code base.
+ * Be share with other people using the same code base.
+ * When running on the same machine, not effect different code bases that all use DiffEngine.
+ * Apply to CI.
+
+Examples:
+
+ * [File type detection](/#file-type-detection).
+ * [Adding a share custom tool](/diff-tool.custom.md). A team may be comparing custom file types, and require a shared custom tool to verify that file.

docs/mdsource/diff-tool.source.md

@@ -41,6 +41,14 @@ By default a maximum of 5 tool instances will be launched. This prevents a chang
 
 This value can be changed:
 
+
+### Using an environment variable
+
+Setting the `DiffEngine.MaxInstances` environment variable to the number of instances to launch.
+
+
+### Using code
+
 snippet: MaxInstancesToLaunch
 
 

docs/mdsource/doc-index.include.md

@@ -1,3 +1,4 @@
  * [Tools](/docs/diff-tool.md)
  * [Tool Order](/docs/diff-tool.order.md)
- * [Custom Tool](/docs/diff-tool.custom.md)
+ * [Custom Tool](/docs/diff-tool.custom.md)
+ * [Code versus machine level settings](/docs/code-verus-machine-settings.md)

docs/readme.md

@@ -9,4 +9,5 @@ To change this file edit the source file and then run MarkdownSnippets.
 
  * [Tools](/docs/diff-tool.md) <!-- include: doc-index. path: /docs/mdsource/doc-index.include.md -->
  * [Tool Order](/docs/diff-tool.order.md)
- * [Custom Tool](/docs/diff-tool.custom.md) <!-- end include: doc-index. path: /docs/mdsource/doc-index.include.md -->
+ * [Custom Tool](/docs/diff-tool.custom.md)
+ * [Code versus machine level settings](/docs/code-verus-machine-settings.md) <!-- end include: doc-index. path: /docs/mdsource/doc-index.include.md -->

readme.md

@@ -33,7 +33,8 @@ Support is available via [Tidelift](https://tidelift.com/subscription/pkg/nuget-
  * [Security contact information](#security-contact-information)<!-- endtoc -->
  * [Tools](/docs/diff-tool.md) <!-- include: doc-index. path: /docs/mdsource/doc-index.include.md -->
  * [Tool Order](/docs/diff-tool.order.md)
- * [Custom Tool](/docs/diff-tool.custom.md) <!-- end include: doc-index. path: /docs/mdsource/doc-index.include.md -->
+ * [Custom Tool](/docs/diff-tool.custom.md)
+ * [Code versus machine level settings](/docs/code-verus-machine-settings.md) <!-- end include: doc-index. path: /docs/mdsource/doc-index.include.md -->
 
 
 ## NuGet package
@@ -76,7 +77,7 @@ A tool can be launched using the following:
 ```cs
 DiffRunner.Launch(tempFile, targetFile);
 ```
-<sup><a href='/src/Tests/DiffRunnerTests.cs#L21-L23' title='File snippet `diffrunnerlaunch` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerlaunch' title='Navigate to start of snippet `diffrunnerlaunch`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffRunnerTests.cs#L20-L22' title='File snippet `diffrunnerlaunch` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerlaunch' title='Navigate to start of snippet `diffrunnerlaunch`'>anchor</a></sup>
 <!-- endsnippet -->
 
 Note that this method will respect the above [difference behavior](/docs/diff-tool.md#detected-difference-behavior) in terms of Auto refresh and MDI behaviors.
@@ -91,15 +92,15 @@ A tool can be closed using the following:
 ```cs
 DiffRunner.Kill(tempFile, targetFile);
 ```
-<sup><a href='/src/Tests/DiffRunnerTests.cs#L31-L33' title='File snippet `diffrunnerkill` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerkill' title='Navigate to start of snippet `diffrunnerkill`'>anchor</a></sup>
+<sup><a href='/src/Tests/DiffRunnerTests.cs#L30-L32' title='File snippet `diffrunnerkill` was extracted from'>snippet source</a> | <a href='#snippet-diffrunnerkill' title='Navigate to start of snippet `diffrunnerkill`'>anchor</a></sup>
 <!-- endsnippet -->
 
 Note that this method will respect the above [difference behavior](/docs/diff-tool.md#detected-difference-behavior) in terms of MDI behavior.
 
 
 ## File type detection
 
-DiffEngine use [EmptyFiles](https://github.com/SimonCropp/EmptyFiles) to determine if a given file or extension is a binary or text.
+DiffEngine use [EmptyFiles](https://github.com/SimonCropp/EmptyFiles) to determine if a given file or extension is a binary or text. Custom extensions can be added, or existing ones changed.
 
 
 ## BuildServerDetector

readme.source.md

@@ -47,7 +47,7 @@ Note that this method will respect the above [difference behavior](/docs/diff-to
 
 ## File type detection
 
-DiffEngine use [EmptyFiles](https://github.com/SimonCropp/EmptyFiles) to determine if a given file or extension is a binary or text.
+DiffEngine use [EmptyFiles](https://github.com/SimonCropp/EmptyFiles) to determine if a given file or extension is a binary or text. Custom extensions can be added, or existing ones changed.
 
 
 ## BuildServerDetector