From 79af67ee9b8f6ba42dbaa08558c7fa3ab28a6024 Mon Sep 17 00:00:00 2001 From: SteveGilham Date: Thu, 14 Nov 2024 09:34:09 +0000 Subject: [PATCH] Documentation updates --- ReleaseNotes.md | 5 ++- .../AltCover.Cake/DotNet/DotNetTest-apidoc.md | 2 +- .../AltCover.Cake/PrepareOptions-apidoc.md | 4 +-- .../{SingleVisit-apidoc.md => All-apidoc.md} | 6 ++-- .../{Defer-apidoc.md => Eager-apidoc.md} | 4 +-- .../AltCover/Options.Prepare-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 4 +-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 4 +-- docs/AltCover.Engine/Abstract-fsapidoc.md | 5 ++- docs/AltCover.Engine/AltCover-fsapidoc.md | 5 ++- .../Abstract.IPrepareOptions-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 6 ++-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 6 ++-- .../AltCover.PrepareOptions-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 6 ++-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 6 ++-- .../AltCover/Prepare-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 6 ++-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 6 ++-- .../Primitive.PrepareOptions-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 6 ++-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 6 ++-- .../PrepareOptions-apidoc.md | 4 +-- .../AltCover/TypeSafe.Package-apidoc.md | 3 +- .../AltCover/TypeSafe.Packages-apidoc.md | 2 +- .../TypeSafe.Packages/AsStrings-apidoc.md | 2 +- .../TypeSafe.PrepareOptions-apidoc.md | 4 +-- .../{Defer-apidoc.md => All-apidoc.md} | 6 ++-- ...{SingleVisit-apidoc.md => Eager-apidoc.md} | 6 ++-- .../PrepareOptions-apidoc.md | 4 +-- docs/AltCover.Engine/Primitive-fsapidoc.md | 5 ++- docs/AltCover.Engine/Tasks-fsapidoc.md | 8 ++--- docs/AltCover.Engine/TypeSafe-fsapidoc.md | 5 ++- .../Abstract-fsapidoc.md | 5 ++- .../AltCover-fsapidoc.md | 5 ++- .../Primitive-fsapidoc.md | 5 ++- .../TypeSafe-fsapidoc.md | 5 ++- .../Monitor/TryGetVisitTotals-apidoc.md | 2 +- .../InvokeAltCoverCommand-apidoc.md | 4 +-- .../{Single-apidoc.md => All-apidoc.md} | 4 +-- .../{Defer-apidoc.md => Eager-apidoc.md} | 6 ++-- docs/PowerShell-integration.md | 34 +++++++++---------- docs/Usage.md | 13 +++---- docs/`dotnet-test`-integration.md | 2 +- 44 files changed, 117 insertions(+), 124 deletions(-) rename docs/AltCover.Cake/AltCover.Cake/PrepareOptions/{SingleVisit-apidoc.md => All-apidoc.md} (62%) rename docs/AltCover.Cake/AltCover.Cake/PrepareOptions/{Defer-apidoc.md => Eager-apidoc.md} (82%) rename docs/AltCover.DotNet/AltCover/Options.Prepare/{Defer-apidoc.md => All-apidoc.md} (75%) rename docs/AltCover.DotNet/AltCover/Options.Prepare/{SingleVisit-apidoc.md => Eager-apidoc.md} (72%) rename docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/{Defer-apidoc.md => All-apidoc.md} (65%) rename docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/{SingleVisit-apidoc.md => Eager-apidoc.md} (63%) rename docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/{Defer-apidoc.md => All-apidoc.md} (65%) rename docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/{SingleVisit-apidoc.md => Eager-apidoc.md} (62%) rename docs/AltCover.Engine/AltCover/Prepare/{Defer-apidoc.md => All-apidoc.md} (65%) rename docs/AltCover.Engine/AltCover/Prepare/{SingleVisit-apidoc.md => Eager-apidoc.md} (62%) rename docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/{Defer-apidoc.md => All-apidoc.md} (65%) rename docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/{SingleVisit-apidoc.md => Eager-apidoc.md} (62%) rename docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/{Defer-apidoc.md => All-apidoc.md} (69%) rename docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/{SingleVisit-apidoc.md => Eager-apidoc.md} (66%) rename docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/{Single-apidoc.md => All-apidoc.md} (80%) rename docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/{Defer-apidoc.md => Eager-apidoc.md} (62%) diff --git a/ReleaseNotes.md b/ReleaseNotes.md index 398512407..73a7a1bf4 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -3,7 +3,10 @@ A. Start with the Quick Start guide : https://github.com/SteveGilham/altcover/wiki/QuickStart-Guide and read the FAQ : https://github.com/SteveGilham/altcover/wiki/FAQ -# (Indori series release 1) +# (Indori series release 2) + +# 9.0.1 (Indori series release 1) +* Net9.0 support * [BREAKING] Minimum platforms for the tools and API are `net472`, `netstandard2.0` and `net8.0`. *NOTE* the recorder assembly still targets `net20` (or `net46` when `async` is detected) * [BREAKING] SDK updates to latest current for Cake (5.0.0) and MSBuild (17.12.6) packages; build with Fake.build 6.1.3 but supports back to 6.0.0 * [BREAKING] API change : `--all` and `--eager` replace `--single` and `--defer`, so the default behaviour is now deferred (Unload/Exit time) reporting, and first visit only per context. *NOTE* in some cases, use of .Net Framework `AppDomain`s may require the use of `--eager` as the unload handler gives no guarantees about execution time. diff --git a/docs/AltCover.Cake/AltCover.Cake/DotNet/DotNetTest-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/DotNet/DotNetTest-apidoc.md index 745c249bf..5d23f0d5a 100644 --- a/docs/AltCover.Cake/AltCover.Cake/DotNet/DotNetTest-apidoc.md +++ b/docs/AltCover.Cake/AltCover.Cake/DotNet/DotNetTest-apidoc.md @@ -13,7 +13,7 @@ This method is a `[CakeMethodAlias]` extension method on `ICakeContext`, and `[C ```csharp public static void DotNetTest(this ICakeContext context, FilePath project, - DotNetCoreTestSettings testSettings, CoverageSettings coverageSettings) + DotNetTestSettings testSettings, CoverageSettings coverageSettings) ``` | parameter | description | diff --git a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md index 28aead392..2446ce005 100644 --- a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md +++ b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions-apidoc.md @@ -11,6 +11,7 @@ public class PrepareOptions | name | description | | --- | --- | | [PrepareOptions](PrepareOptions/PrepareOptions-apidoc)() | The default constructor. | +| virtual [All](PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` | | virtual [AssemblyExcludeFilter](PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | virtual [AssemblyFilter](PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | virtual [AttributeFilter](PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -18,8 +19,8 @@ public class PrepareOptions | virtual [BranchCover](PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` | | virtual [CallContext](PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](PrepareOptions/CommandLine-apidoc) { get; } | Gets the command line (overridden by the MSBuild integration) | -| [Defer](PrepareOptions/Defer-apidoc) { get; } | Gets whether to defer coverage reporting (overridden by the MSBuild integration) | | virtual [Dependencies](PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](PrepareOptions/Eager-apidoc) { get; } | Gets whether to defer coverage reporting (overridden by the MSBuild integration) | | [ExposeReturnCode](PrepareOptions/ExposeReturnCode-apidoc) { get; } | Gets whether to expose a program return code (overridden by the MSBuild integration) | | virtual [FileFilter](PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | virtual [InPlace](PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` | @@ -39,7 +40,6 @@ public class PrepareOptions | virtual [Save](PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` | | virtual [ShowGenerated](PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` | | virtual [ShowStatic](PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` | -| virtual [SingleVisit](PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` | | virtual [SourceLink](PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` | | virtual [StrongNameKey](PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | virtual [SymbolDirectories](PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/SingleVisit-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/All-apidoc.md similarity index 62% rename from docs/AltCover.Cake/AltCover.Cake/PrepareOptions/SingleVisit-apidoc.md rename to docs/AltCover.Cake/AltCover.Cake/PrepareOptions/All-apidoc.md index 0b43bc8b5..1804755ed 100644 --- a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/SingleVisit-apidoc.md +++ b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/All-apidoc.md @@ -1,9 +1,9 @@ -# PrepareOptions.SingleVisit property +# PrepareOptions.All property -Corresponds to command line option `--single` +Corresponds to command line option `--all` ```csharp -public virtual bool SingleVisit { get; } +public virtual bool All { get; } ``` ## See Also diff --git a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Defer-apidoc.md b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Eager-apidoc.md similarity index 82% rename from docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Defer-apidoc.md rename to docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Eager-apidoc.md index c9d0d903e..dcc7874c1 100644 --- a/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Defer-apidoc.md +++ b/docs/AltCover.Cake/AltCover.Cake/PrepareOptions/Eager-apidoc.md @@ -1,9 +1,9 @@ -# PrepareOptions.Defer property +# PrepareOptions.Eager property Gets whether to defer coverage reporting (overridden by the MSBuild integration) ```csharp -public bool Defer { get; } +public bool Eager { get; } ``` ## See Also diff --git a/docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md b/docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md index 8e2fc14c7..accc2bca9 100644 --- a/docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md +++ b/docs/AltCover.DotNet/AltCover/Options.Prepare-apidoc.md @@ -9,6 +9,7 @@ public class Prepare | name | description | | --- | --- | | [Prepare](Options.Prepare/Prepare-apidoc)() | The default constructor. | +| [All](Options.Prepare/All-apidoc) { get; set; } | | | [AssemblyExcludeFilter](Options.Prepare/AssemblyExcludeFilter-apidoc) { get; set; } | | | [AssemblyFilter](Options.Prepare/AssemblyFilter-apidoc) { get; set; } | | | [AttributeFilter](Options.Prepare/AttributeFilter-apidoc) { get; set; } | | @@ -16,8 +17,8 @@ public class Prepare | [BranchCover](Options.Prepare/BranchCover-apidoc) { get; set; } | | | [CallContext](Options.Prepare/CallContext-apidoc) { get; set; } | | | [CommandLine](Options.Prepare/CommandLine-apidoc) { get; set; } | | -| [Defer](Options.Prepare/Defer-apidoc) { get; set; } | | | [Dependencies](Options.Prepare/Dependencies-apidoc) { get; set; } | | +| [Eager](Options.Prepare/Eager-apidoc) { get; set; } | | | [ExposeReturnCode](Options.Prepare/ExposeReturnCode-apidoc) { get; set; } | | | [FileFilter](Options.Prepare/FileFilter-apidoc) { get; set; } | | | [InPlace](Options.Prepare/InPlace-apidoc) { get; set; } | | @@ -37,7 +38,6 @@ public class Prepare | [Save](Options.Prepare/Save-apidoc) { get; set; } | | | [ShowGenerated](Options.Prepare/ShowGenerated-apidoc) { get; set; } | | | [ShowStatic](Options.Prepare/ShowStatic-apidoc) { get; set; } | | -| [SingleVisit](Options.Prepare/SingleVisit-apidoc) { get; set; } | | | [SourceLink](Options.Prepare/SourceLink-apidoc) { get; set; } | | | [StrongNameKey](Options.Prepare/StrongNameKey-apidoc) { get; set; } | | | [SymbolDirectories](Options.Prepare/SymbolDirectories-apidoc) { get; set; } | | diff --git a/docs/AltCover.DotNet/AltCover/Options.Prepare/Defer-apidoc.md b/docs/AltCover.DotNet/AltCover/Options.Prepare/All-apidoc.md similarity index 75% rename from docs/AltCover.DotNet/AltCover/Options.Prepare/Defer-apidoc.md rename to docs/AltCover.DotNet/AltCover/Options.Prepare/All-apidoc.md index efe5398c7..80c5ae14d 100644 --- a/docs/AltCover.DotNet/AltCover/Options.Prepare/Defer-apidoc.md +++ b/docs/AltCover.DotNet/AltCover/Options.Prepare/All-apidoc.md @@ -1,7 +1,7 @@ -# Options.Prepare.Defer property +# Options.Prepare.All property ```csharp -public bool Defer { get; set; } +public bool All { get; set; } ``` ## See Also diff --git a/docs/AltCover.DotNet/AltCover/Options.Prepare/SingleVisit-apidoc.md b/docs/AltCover.DotNet/AltCover/Options.Prepare/Eager-apidoc.md similarity index 72% rename from docs/AltCover.DotNet/AltCover/Options.Prepare/SingleVisit-apidoc.md rename to docs/AltCover.DotNet/AltCover/Options.Prepare/Eager-apidoc.md index cd245919e..81a64066b 100644 --- a/docs/AltCover.DotNet/AltCover/Options.Prepare/SingleVisit-apidoc.md +++ b/docs/AltCover.DotNet/AltCover/Options.Prepare/Eager-apidoc.md @@ -1,7 +1,7 @@ -# Options.Prepare.SingleVisit property +# Options.Prepare.Eager property ```csharp -public bool SingleVisit { get; set; } +public bool Eager { get; set; } ``` ## See Also diff --git a/docs/AltCover.Engine/Abstract-fsapidoc.md b/docs/AltCover.Engine/Abstract-fsapidoc.md index a67e6a0df..75668a3d4 100644 --- a/docs/AltCover.Engine/Abstract-fsapidoc.md +++ b/docs/AltCover.Engine/Abstract-fsapidoc.md @@ -46,7 +46,6 @@ The members correspond to the like-named command line options for `AltCover Runn The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` type IPrepareOptions = @@ -73,13 +72,13 @@ The members correspond to the like-named command line options for `AltCover`, ex abstract member Save : bool with get abstract member ZipFile : bool with get abstract member MethodPoint : bool with get - abstract member SingleVisit : bool with get + abstract member All : bool with get abstract member LineCover : bool with get abstract member BranchCover : bool with get abstract member CommandLine : IEnumerable with get abstract member ExposeReturnCode : bool with get abstract member SourceLink : bool with get - abstract member Defer : bool with get + abstract member Eager : bool with get abstract member LocalSource : bool with get abstract member VisibleBranches : bool with get abstract member ShowStatic : string with get diff --git a/docs/AltCover.Engine/AltCover-fsapidoc.md b/docs/AltCover.Engine/AltCover-fsapidoc.md index a6f79b603..f369e209f 100644 --- a/docs/AltCover.Engine/AltCover-fsapidoc.md +++ b/docs/AltCover.Engine/AltCover-fsapidoc.md @@ -83,7 +83,6 @@ The property members corresponding to the command line options read the values f The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -116,13 +115,13 @@ The members correspond to the like-named command line options for `AltCover`, ex member Save : bool member ZipFile : bool member MethodPoint : bool - member SingleVisit : bool + member All : bool member LineCover : bool member BranchCover : bool member CommandLine : seq member ExposeReturnCode : bool member SourceLink : bool - member Defer : bool + member Eager : bool member LocalSource : bool member VisibleBranches : bool member ShowStatic : string diff --git a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions-apidoc.md index 61a928e42..e96ae9cce 100644 --- a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions-apidoc.md @@ -24,6 +24,7 @@ public interface IPrepareOptions | name | description | | --- | --- | +| [All](Abstract.IPrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` | | [AssemblyExcludeFilter](Abstract.IPrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | [AssemblyFilter](Abstract.IPrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | [AttributeFilter](Abstract.IPrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -31,8 +32,8 @@ public interface IPrepareOptions | [BranchCover](Abstract.IPrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` | | [CallContext](Abstract.IPrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](Abstract.IPrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` | -| [Defer](Abstract.IPrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` | | [Dependencies](Abstract.IPrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](Abstract.IPrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` | | [ExposeReturnCode](Abstract.IPrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [FileFilter](Abstract.IPrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | [InPlace](Abstract.IPrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` | @@ -52,7 +53,6 @@ public interface IPrepareOptions | [Save](Abstract.IPrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` | | [ShowGenerated](Abstract.IPrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` | | [ShowStatic](Abstract.IPrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` | -| [SingleVisit](Abstract.IPrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` | | [SourceLink](Abstract.IPrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` | | [StrongNameKey](Abstract.IPrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | [SymbolDirectories](Abstract.IPrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Defer-apidoc.md b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/All-apidoc.md similarity index 65% rename from docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Defer-apidoc.md rename to docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/All-apidoc.md index 19b2b34aa..72731e7fa 100644 --- a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Defer-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/All-apidoc.md @@ -1,9 +1,9 @@ -# Abstract.IPrepareOptions.Defer property +# Abstract.IPrepareOptions.All property -Corresponds to command line option `--defer` +Corresponds to command line option `--all` ```csharp -public bool Defer { get; } +public bool All { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/SingleVisit-apidoc.md b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Eager-apidoc.md similarity index 63% rename from docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/SingleVisit-apidoc.md rename to docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Eager-apidoc.md index 944018b96..4423ac397 100644 --- a/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/SingleVisit-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Abstract.IPrepareOptions/Eager-apidoc.md @@ -1,9 +1,9 @@ -# Abstract.IPrepareOptions.SingleVisit property +# Abstract.IPrepareOptions.Eager property -Corresponds to command line option `--single` +Corresponds to command line option `--eager` ```csharp -public bool SingleVisit { get; } +public bool Eager { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions-apidoc.md index fa0d16d8b..80c143b99 100644 --- a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions-apidoc.md @@ -13,6 +13,7 @@ public abstract class PrepareOptions : IEquatable, IStructuralEq | static [NewAbstract](AltCover.PrepareOptions/NewAbstract-apidoc)(…) | | | static [NewPrimitive](AltCover.PrepareOptions/NewPrimitive-apidoc)(…) | | | static [NewTypeSafe](AltCover.PrepareOptions/NewTypeSafe-apidoc)(…) | | +| [All](AltCover.PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` | | [AssemblyExcludeFilter](AltCover.PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | [AssemblyFilter](AltCover.PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | [AttributeFilter](AltCover.PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -20,8 +21,8 @@ public abstract class PrepareOptions : IEquatable, IStructuralEq | [BranchCover](AltCover.PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` | | [CallContext](AltCover.PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](AltCover.PrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` | -| [Defer](AltCover.PrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` | | [Dependencies](AltCover.PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](AltCover.PrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` | | [ExposeReturnCode](AltCover.PrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [FileFilter](AltCover.PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | [InPlace](AltCover.PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` | @@ -41,7 +42,6 @@ public abstract class PrepareOptions : IEquatable, IStructuralEq | [Save](AltCover.PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` | | [ShowGenerated](AltCover.PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` | | [ShowStatic](AltCover.PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` | -| [SingleVisit](AltCover.PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` | | [SourceLink](AltCover.PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` | | [StrongNameKey](AltCover.PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | [SymbolDirectories](AltCover.PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Defer-apidoc.md b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/All-apidoc.md similarity index 65% rename from docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Defer-apidoc.md rename to docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/All-apidoc.md index 8519d2c29..5eb02a94c 100644 --- a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Defer-apidoc.md +++ b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/All-apidoc.md @@ -1,9 +1,9 @@ -# AltCover.PrepareOptions.Defer property +# AltCover.PrepareOptions.All property -Corresponds to command line option `--defer` +Corresponds to command line option `--all` ```csharp -public bool Defer { get; } +public bool All { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/SingleVisit-apidoc.md b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Eager-apidoc.md similarity index 62% rename from docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/SingleVisit-apidoc.md rename to docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Eager-apidoc.md index 4de8da1bf..546c5484e 100644 --- a/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/SingleVisit-apidoc.md +++ b/docs/AltCover.Engine/AltCover/AltCover.PrepareOptions/Eager-apidoc.md @@ -1,9 +1,9 @@ -# AltCover.PrepareOptions.SingleVisit property +# AltCover.PrepareOptions.Eager property -Corresponds to command line option `--single` +Corresponds to command line option `--eager` ```csharp -public bool SingleVisit { get; } +public bool Eager { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Prepare-apidoc.md b/docs/AltCover.Engine/AltCover/Prepare-apidoc.md index 9b545490f..3e2d8449a 100644 --- a/docs/AltCover.Engine/AltCover/Prepare-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Prepare-apidoc.md @@ -11,6 +11,7 @@ public class Prepare : Task | name | description | | --- | --- | | [Prepare](Prepare/Prepare-apidoc)() | The default constructor | +| [All](Prepare/All-apidoc) { get; set; } | Corresponds to command line option `--all` | | [AssemblyExcludeFilter](Prepare/AssemblyExcludeFilter-apidoc) { get; set; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | [AssemblyFilter](Prepare/AssemblyFilter-apidoc) { get; set; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | [AttributeFilter](Prepare/AttributeFilter-apidoc) { get; set; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -18,8 +19,8 @@ public class Prepare : Task | [BranchCover](Prepare/BranchCover-apidoc) { get; set; } | Corresponds to command line option `--branchcover` | | [CallContext](Prepare/CallContext-apidoc) { get; set; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](Prepare/CommandLine-apidoc) { get; set; } | Corresponds to the command line to run, given after a `-- ` | -| [Defer](Prepare/Defer-apidoc) { get; set; } | Corresponds to command line option `--defer` | | [Dependencies](Prepare/Dependencies-apidoc) { get; set; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](Prepare/Eager-apidoc) { get; set; } | Corresponds to command line option `--eager` | | [ExposeReturnCode](Prepare/ExposeReturnCode-apidoc) { get; set; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [FileFilter](Prepare/FileFilter-apidoc) { get; set; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | [InPlace](Prepare/InPlace-apidoc) { get; set; } | Corresponds to command line option `--inplace` | @@ -38,7 +39,6 @@ public class Prepare : Task | [Save](Prepare/Save-apidoc) { get; set; } | Corresponds to command line option `--save` | | [ShowGenerated](Prepare/ShowGenerated-apidoc) { get; set; } | Corresponds to command line option `--showGenerated` | | [ShowStatic](Prepare/ShowStatic-apidoc) { get; set; } | Corresponds to command line option `--showstatic[=VALUE]` | -| [SingleVisit](Prepare/SingleVisit-apidoc) { get; set; } | Corresponds to command line option `--single` | | [SourceLink](Prepare/SourceLink-apidoc) { get; set; } | Corresponds to command line option `--sourcelink` | | [StrongNameKey](Prepare/StrongNameKey-apidoc) { get; set; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | [SymbolDirectories](Prepare/SymbolDirectories-apidoc) { get; set; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/Prepare/Defer-apidoc.md b/docs/AltCover.Engine/AltCover/Prepare/All-apidoc.md similarity index 65% rename from docs/AltCover.Engine/AltCover/Prepare/Defer-apidoc.md rename to docs/AltCover.Engine/AltCover/Prepare/All-apidoc.md index 3bea512a5..b7766c6f3 100644 --- a/docs/AltCover.Engine/AltCover/Prepare/Defer-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Prepare/All-apidoc.md @@ -1,9 +1,9 @@ -# Prepare.Defer property +# Prepare.All property -Corresponds to command line option `--defer` +Corresponds to command line option `--all` ```csharp -public bool Defer { get; set; } +public bool All { get; set; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Prepare/SingleVisit-apidoc.md b/docs/AltCover.Engine/AltCover/Prepare/Eager-apidoc.md similarity index 62% rename from docs/AltCover.Engine/AltCover/Prepare/SingleVisit-apidoc.md rename to docs/AltCover.Engine/AltCover/Prepare/Eager-apidoc.md index 0da1b05d3..162547cc7 100644 --- a/docs/AltCover.Engine/AltCover/Prepare/SingleVisit-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Prepare/Eager-apidoc.md @@ -1,9 +1,9 @@ -# Prepare.SingleVisit property +# Prepare.Eager property -Corresponds to command line option `--single` +Corresponds to command line option `--eager` ```csharp -public bool SingleVisit { get; set; } +public bool Eager { get; set; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions-apidoc.md index daf3e9330..1b6a0f1dd 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions-apidoc.md @@ -12,6 +12,7 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | --- | --- | | [PrepareOptions](Primitive.PrepareOptions/PrepareOptions-apidoc)(…) | | | static [Create](Primitive.PrepareOptions/Create-apidoc)() | Returns an instance with all fields empty that has all empty or `false` fields except `ExposeReturnCode`, `OpenCover`, `InPlace` and `Save` are `true`, and `ShowStatic` is `-` | +| [All](Primitive.PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` | | [AssemblyExcludeFilter](Primitive.PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | [AssemblyFilter](Primitive.PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | [AttributeFilter](Primitive.PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -19,8 +20,8 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | [BranchCover](Primitive.PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` | | [CallContext](Primitive.PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](Primitive.PrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` | -| [Defer](Primitive.PrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` | | [Dependencies](Primitive.PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](Primitive.PrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` | | [ExposeReturnCode](Primitive.PrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [FileFilter](Primitive.PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | [InPlace](Primitive.PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` | @@ -40,7 +41,6 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | [Save](Primitive.PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` | | [ShowGenerated](Primitive.PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` | | [ShowStatic](Primitive.PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` | -| [SingleVisit](Primitive.PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` | | [SourceLink](Primitive.PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` | | [StrongNameKey](Primitive.PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | [SymbolDirectories](Primitive.PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Defer-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/All-apidoc.md similarity index 65% rename from docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Defer-apidoc.md rename to docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/All-apidoc.md index 732ddce46..ede0e7793 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Defer-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/All-apidoc.md @@ -1,9 +1,9 @@ -# Primitive.PrepareOptions.Defer property +# Primitive.PrepareOptions.All property -Corresponds to command line option `--defer` +Corresponds to command line option `--all` ```csharp -public bool Defer { get; } +public bool All { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/SingleVisit-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Eager-apidoc.md similarity index 62% rename from docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/SingleVisit-apidoc.md rename to docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Eager-apidoc.md index 1d9712949..0463fa8ca 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/SingleVisit-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/Eager-apidoc.md @@ -1,9 +1,9 @@ -# Primitive.PrepareOptions.SingleVisit property +# Primitive.PrepareOptions.Eager property -Corresponds to command line option `--single` +Corresponds to command line option `--eager` ```csharp -public bool SingleVisit { get; } +public bool Eager { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/PrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/PrepareOptions-apidoc.md index 7b42255dd..71cf5e1c5 100644 --- a/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/PrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/Primitive.PrepareOptions/PrepareOptions-apidoc.md @@ -9,9 +9,9 @@ public PrepareOptions(IEnumerable inputDirectories, IEnumerable IEnumerable attributeFilter, IEnumerable pathFilter, IEnumerable attributeTopLevel, IEnumerable typeTopLevel, IEnumerable methodTopLevel, IEnumerable callContext, string reportFormat, - bool inPlace, bool save, bool zipFile, bool methodPoint, bool singleVisit, bool lineCover, + bool inPlace, bool save, bool zipFile, bool methodPoint, bool all, bool lineCover, bool branchCover, IEnumerable commandLine, bool exposeReturnCode, bool sourceLink, - bool defer, bool localSource, bool visibleBranches, string showStatic, bool showGenerated, + bool eager, bool localSource, bool visibleBranches, string showStatic, bool showGenerated, TraceLevel verbosity, bool trivia, string outputRoot, bool portable) ``` diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md index ae1d4a2a4..fd2175c96 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Package-apidoc.md @@ -1,6 +1,6 @@ # TypeSafe.Package class -Corresponds to a value after `-- ` on the command line +Corresponds to a cobertura package source root ```csharp public sealed class Package : IEquatable, IStructuralEquatable @@ -12,6 +12,7 @@ public sealed class Package : IEquatable, IStructuralEquatable | --- | --- | | static [NewPackage](TypeSafe.Package/NewPackage-apidoc)(…) | | | [AsString](TypeSafe.Package/AsString-apidoc)() | Returns the string to be used as a package root | + ## See Also * class [TypeSafe](./TypeSafe-apidoc) diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md index 6a7e0c110..1e04c8f1d 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages-apidoc.md @@ -1,6 +1,6 @@ # TypeSafe.Packages class -Corresponds to the values after `-- ` on the command line +Corresponds to a collection of cobertura package source roots ```csharp public abstract class Packages : IEquatable, IStructuralEquatable diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md index 091e85990..b2e6515c0 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.Packages/AsStrings-apidoc.md @@ -8,7 +8,7 @@ public IEnumerable AsStrings() ## Return Value -the strings to be used to be used as package roots +the strings to be used as package roots ## See Also diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions-apidoc.md index b18be2f88..8bbe3434e 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions-apidoc.md @@ -12,6 +12,7 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | --- | --- | | [PrepareOptions](TypeSafe.PrepareOptions/PrepareOptions-apidoc)(…) | | | static [Create](TypeSafe.PrepareOptions/Create-apidoc)() | returns an instance that has all fields unset/default except `ExposeReturnCode`, `InPlace` and `Save` are `Set` | +| [All](TypeSafe.PrepareOptions/All-apidoc) { get; } | Corresponds to command line option `--all` | | [AssemblyExcludeFilter](TypeSafe.PrepareOptions/AssemblyExcludeFilter-apidoc) { get; } | Corresponds to command line option `-e, --assemblyExcludeFilter=VALUE` | | [AssemblyFilter](TypeSafe.PrepareOptions/AssemblyFilter-apidoc) { get; } | Corresponds to command line option `-s, --assemblyFilter=VALUE` | | [AttributeFilter](TypeSafe.PrepareOptions/AttributeFilter-apidoc) { get; } | Corresponds to command line option `-a, --attributeFilter=VALUE` | @@ -19,8 +20,8 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | [BranchCover](TypeSafe.PrepareOptions/BranchCover-apidoc) { get; } | Corresponds to command line option `--branchcover` | | [CallContext](TypeSafe.PrepareOptions/CallContext-apidoc) { get; } | Corresponds to command line option `-c, --callContext=VALUE` | | [CommandLine](TypeSafe.PrepareOptions/CommandLine-apidoc) { get; } | Corresponds to the command line to run, given after a `-- ` | -| [Defer](TypeSafe.PrepareOptions/Defer-apidoc) { get; } | Corresponds to command line option `--defer` | | [Dependencies](TypeSafe.PrepareOptions/Dependencies-apidoc) { get; } | Corresponds to command line option `-d, --dependency=VALUE` | +| [Eager](TypeSafe.PrepareOptions/Eager-apidoc) { get; } | Corresponds to command line option `--eager` | | [ExposeReturnCode](TypeSafe.PrepareOptions/ExposeReturnCode-apidoc) { get; } | Corresponds to the converse of command line option `--dropReturnCode ` | | [FileFilter](TypeSafe.PrepareOptions/FileFilter-apidoc) { get; } | Corresponds to command line option `-f, --fileFilter=VALUE` | | [InPlace](TypeSafe.PrepareOptions/InPlace-apidoc) { get; } | Corresponds to command line option `--inplace` | @@ -40,7 +41,6 @@ public sealed class PrepareOptions : IEquatable, IStructuralEqua | [Save](TypeSafe.PrepareOptions/Save-apidoc) { get; } | Corresponds to command line option `--save` | | [ShowGenerated](TypeSafe.PrepareOptions/ShowGenerated-apidoc) { get; } | Corresponds to command line option `--showGenerated` | | [ShowStatic](TypeSafe.PrepareOptions/ShowStatic-apidoc) { get; } | Corresponds to command line option `--showstatic[=VALUE]` | -| [SingleVisit](TypeSafe.PrepareOptions/SingleVisit-apidoc) { get; } | Corresponds to command line option `--single` | | [SourceLink](TypeSafe.PrepareOptions/SourceLink-apidoc) { get; } | Corresponds to command line option `--sourcelink` | | [StrongNameKey](TypeSafe.PrepareOptions/StrongNameKey-apidoc) { get; } | Corresponds to command line option `--sn, --strongNameKey=VALUE` | | [SymbolDirectories](TypeSafe.PrepareOptions/SymbolDirectories-apidoc) { get; } | Corresponds to command line option `-y, --symbolDirectory=VALUE` | diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Defer-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/All-apidoc.md similarity index 69% rename from docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Defer-apidoc.md rename to docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/All-apidoc.md index e13bf4e1e..56bfa9427 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Defer-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/All-apidoc.md @@ -1,9 +1,9 @@ -# TypeSafe.PrepareOptions.Defer property +# TypeSafe.PrepareOptions.All property -Corresponds to command line option `--defer` +Corresponds to command line option `--all` ```csharp -public Flag Defer { get; } +public Flag All { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/SingleVisit-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Eager-apidoc.md similarity index 66% rename from docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/SingleVisit-apidoc.md rename to docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Eager-apidoc.md index c2f963caa..6703ca30e 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/SingleVisit-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/Eager-apidoc.md @@ -1,9 +1,9 @@ -# TypeSafe.PrepareOptions.SingleVisit property +# TypeSafe.PrepareOptions.Eager property -Corresponds to command line option `--single` +Corresponds to command line option `--eager` ```csharp -public Flag SingleVisit { get; } +public Flag Eager { get; } ``` ## See Also diff --git a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/PrepareOptions-apidoc.md b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/PrepareOptions-apidoc.md index b0059142a..7b84d26b9 100644 --- a/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/PrepareOptions-apidoc.md +++ b/docs/AltCover.Engine/AltCover/TypeSafe.PrepareOptions/PrepareOptions-apidoc.md @@ -7,8 +7,8 @@ public PrepareOptions(DirectoryPaths inputDirectories, DirectoryPaths outputDire Filters assemblyExcludeFilter, Filters typeFilter, Filters methodFilter, Filters attributeFilter, Filters pathFilter, Filters attributeTopLevel, Filters typeTopLevel, Filters methodTopLevel, Context callContext, ReportFormat reportFormat, Flag inPlace, - Flag save, Flag zipFile, Flag methodPoint, Flag singleVisit, Flag lineCover, Flag branchCover, - CommandLine commandLine, Flag exposeReturnCode, Flag sourceLink, Flag defer, Flag localSource, + Flag save, Flag zipFile, Flag methodPoint, Flag all, Flag lineCover, Flag branchCover, + CommandLine commandLine, Flag exposeReturnCode, Flag sourceLink, Flag eager, Flag localSource, Flag visibleBranches, StaticFormat showStatic, Flag showGenerated, TraceLevel verbosity, Flag trivia, FilePath outputRoot, Flag portable) ``` diff --git a/docs/AltCover.Engine/Primitive-fsapidoc.md b/docs/AltCover.Engine/Primitive-fsapidoc.md index d3d651d3e..a78d8bf15 100644 --- a/docs/AltCover.Engine/Primitive-fsapidoc.md +++ b/docs/AltCover.Engine/Primitive-fsapidoc.md @@ -56,7 +56,6 @@ Fields that are not applicable to the use case or platform are silently ignored. The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -85,13 +84,13 @@ The members correspond to the like-named command line options for `AltCover`, ex Save: bool ZipFile: bool MethodPoint: bool - SingleVisit: bool + All: bool LineCover: bool BranchCover: bool CommandLine: seq ExposeReturnCode: bool SourceLink: bool - Defer: bool + Eager: bool LocalSource: bool VisibleBranches: bool ShowStatic: string diff --git a/docs/AltCover.Engine/Tasks-fsapidoc.md b/docs/AltCover.Engine/Tasks-fsapidoc.md index 3d3f35839..4e21abbfa 100644 --- a/docs/AltCover.Engine/Tasks-fsapidoc.md +++ b/docs/AltCover.Engine/Tasks-fsapidoc.md @@ -7,12 +7,12 @@ Both the .net framework/mono and .net core releases publish MSBuild tasks from t For the C# programmer, attributes have the extra angle-brackets, while `member [Name] : [type] with get, set` is a `[type]` valued property called `[Name]`; and `string array` is just `string[]` spelled out longhand. -For `AltCover.Prepare` and `AltCover.Collect`, the task parameters match the command line arguments in name and function, except that `SymbolDirectories` is pluralised, `SingleVisit` represents the `--single` option, `ExposeReturnCode` is the converse of the command line option `dropReturnCode`, and `CommandLine` is everything after a `--` . If `AltCover.Collect`'s `Executable` parameter is set, that switches the virtual `--collect` flag off. +For `AltCover.Prepare` and `AltCover.Collect`, the task parameters match the command line arguments in name and function, except that `SymbolDirectories` is pluralised, `ExposeReturnCode` is the converse of the command line option `dropReturnCode`, and `CommandLine` is everything after a `--` . If `AltCover.Collect`'s `Executable` parameter is set, that switches the virtual `--collect` flag off. ``` namespace AltCover ``` ## Task `AltCover.Prepare` -This is the instrumentation mode with `--save --inplace --defer` as default. Associated parameters are +This is the instrumentation mode with `--save --inplace` as default. Associated parameters are ``` type Prepare = class @@ -42,13 +42,13 @@ type Prepare = member Save : bool with get, set member ZipFile : bool with get, set member MethodPoint : bool with get, set - member SingleVisit : bool with get, set + member All : bool with get, set member LineCover : bool with get, set member BranchCover : bool with get, set member CommandLine : string array with get, set member ExposeReturnCode : bool with get, set member SourceLink : bool with get, set - member Defer : bool with get, set + member Eager : bool with get, set member LocalSource : bool with get, set member VisibleBranches : bool with get, set member ShowStatic : string with get, set diff --git a/docs/AltCover.Engine/TypeSafe-fsapidoc.md b/docs/AltCover.Engine/TypeSafe-fsapidoc.md index 4e56884a5..9acea6909 100644 --- a/docs/AltCover.Engine/TypeSafe-fsapidoc.md +++ b/docs/AltCover.Engine/TypeSafe-fsapidoc.md @@ -229,7 +229,6 @@ Fields that are not applicable to the use case or platform are silently ignored. The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -258,13 +257,13 @@ The members correspond to the like-named command line options for `AltCover`, ex Save: Flag ZipFile: Flag MethodPoint: Flag - SingleVisit: Flag + All: Flag LineCover: Flag BranchCover: Flag CommandLine: CommandLine ExposeReturnCode: Flag SourceLink: Flag - Defer: Flag + Eager: Flag LocalSource: Flag VisibleBranches: Flag ShowStatic: StaticFormat diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md index 153f0cf76..23560868e 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/Abstract-fsapidoc.md @@ -46,7 +46,6 @@ The members correspond to the like-named command line options for `AltCover Runn The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` type IPrepareOptions = @@ -73,13 +72,13 @@ The members correspond to the like-named command line options for `AltCover`, ex abstract member Save : bool with get abstract member ZipFile : bool with get abstract member MethodPoint : bool with get - abstract member SingleVisit : bool with get + abstract member All : bool with get abstract member LineCover : bool with get abstract member BranchCover : bool with get abstract member CommandLine : IEnumerable with get abstract member ExposeReturnCode : bool with get abstract member SourceLink : bool with get - abstract member Defer : bool with get + abstract member Eager : bool with get abstract member LocalSource : bool with get abstract member VisibleBranches : bool with get abstract member ShowStatic : string with get diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md index fc9fa3250..03f52187d 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/AltCover-fsapidoc.md @@ -101,7 +101,6 @@ The property members corresponding to the command line options read the values f The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -134,13 +133,13 @@ The members correspond to the like-named command line options for `AltCover`, ex member Save : bool member ZipFile : bool member MethodPoint : bool - member SingleVisit : bool + member All : bool member LineCover : bool member BranchCover : bool member CommandLine : seq member ExposeReturnCode : bool member SourceLink : bool - member Defer : bool + member Eager : bool member LocalSource : bool member VisibleBranches : bool member ShowStatic : string diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md index ed9f1ceaf..bd48b5b91 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/Primitive-fsapidoc.md @@ -56,7 +56,6 @@ Fields that are not applicable to the use case or platform are silently ignored. The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -85,13 +84,13 @@ The members correspond to the like-named command line options for `AltCover`, ex Save: bool ZipFile: bool MethodPoint: bool - SingleVisit: bool + All: bool LineCover: bool BranchCover: bool CommandLine: seq ExposeReturnCode: bool SourceLink: bool - Defer: bool + Eager: bool LocalSource: bool VisibleBranches: bool ShowStatic: string diff --git a/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md b/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md index c0d73a077..0961108fd 100644 --- a/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md +++ b/docs/AltCover.Fake.DotNet.Testing.AltCover/TypeSafe-fsapidoc.md @@ -229,7 +229,6 @@ Fields that are not applicable to the use case or platform are silently ignored. The members correspond to the like-named command line options for `AltCover`, except * `ExposeReturnCode` being the converse of the `dropReturnCode` option * `CommandLine` being the material after a `-- ` -* `SingleVisit` being the name for `--single` ``` [] @@ -258,13 +257,13 @@ The members correspond to the like-named command line options for `AltCover`, ex Save: Flag ZipFile: Flag MethodPoint: Flag - SingleVisit: Flag + All: Flag LineCover: Flag BranchCover: Flag CommandLine: CommandLine ExposeReturnCode: Flag SourceLink: Flag - Defer: Flag + Eager: Flag LocalSource: Flag VisibleBranches: Flag ShowStatic: StaticFormat diff --git a/docs/AltCover.Monitor/AltCover/Monitor/TryGetVisitTotals-apidoc.md b/docs/AltCover.Monitor/AltCover/Monitor/TryGetVisitTotals-apidoc.md index ec3b589b6..7187b1f34 100644 --- a/docs/AltCover.Monitor/AltCover/Monitor/TryGetVisitTotals-apidoc.md +++ b/docs/AltCover.Monitor/AltCover/Monitor/TryGetVisitTotals-apidoc.md @@ -16,7 +16,7 @@ True if running under AltCover coverage ## Remarks -Current implementation requires `dotnet test`, or other command-line testing with `--defer` set, in which the cumulative visit numbers are available, rather than everything having been dumped to file instead. +Current implementation requires `dotnet test`, or other command-line testing with `--eager` NOT set, in which the cumulative visit numbers are available, rather than everything having been dumped to file instead. ## See Also diff --git a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md index 1e1fc1a85..eb303344c 100644 --- a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md +++ b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand-apidoc.md @@ -25,6 +25,7 @@ public class InvokeAltCoverCommand : PSCmdlet | name | description | | --- | --- | | [InvokeAltCoverCommand](InvokeAltCoverCommand/InvokeAltCoverCommand-apidoc)() | The default constructor. | +| [All](InvokeAltCoverCommand/All-apidoc) { get; set; } | only record the first hit at any location (or first for that context if `-CallContext` is operating). | | [AssemblyExcludeFilter](InvokeAltCoverCommand/AssemblyExcludeFilter-apidoc) { get; set; } | Assembly names to exclude from instrumentation (linked to instrumented assemblies) | | [AssemblyFilter](InvokeAltCoverCommand/AssemblyFilter-apidoc) { get; set; } | Assembly names to exclude from instrumentation (linked by instrumented assemblies) | | [AttributeFilter](InvokeAltCoverCommand/AttributeFilter-apidoc) { get; set; } | Attribute names to exclude from instrumentation | @@ -33,9 +34,9 @@ public class InvokeAltCoverCommand : PSCmdlet | [CallContext](InvokeAltCoverCommand/CallContext-apidoc) { get; set; } | Tracking either times of visits in ticks or designated method calls leading to the visits. | | [Cobertura](InvokeAltCoverCommand/Cobertura-apidoc) { get; set; } | File path for Cobertura format version of the collected data | | [CommandLine](InvokeAltCoverCommand/CommandLine-apidoc) { get; set; } | Arguments for a launched process | -| [Defer](InvokeAltCoverCommand/Defer-apidoc) { get; set; } | Defers writing runner-mode coverage data until process exit. | | [Dependency](InvokeAltCoverCommand/Dependency-apidoc) { get; set; } | Assembly paths to resolve missing references. | | [DropReturnCode](InvokeAltCoverCommand/DropReturnCode-apidoc) { get; set; } | Do not report any non-zero return code from a launched process. | +| [Eager](InvokeAltCoverCommand/Eager-apidoc) { get; set; } | Write runner-mode coverage data immediately. | | [Executable](InvokeAltCoverCommand/Executable-apidoc) { get; set; } | The executable to run e.g. `dotnet` | | [FileFilter](InvokeAltCoverCommand/FileFilter-apidoc) { get; set; } | Source file names to exclude from instrumentation | | [InPlace](InvokeAltCoverCommand/InPlace-apidoc) { get; set; } | Instrument the inputDirectory, rather than the outputDirectory (e.g. for `dotnet test`) | @@ -59,7 +60,6 @@ public class InvokeAltCoverCommand : PSCmdlet | [Save](InvokeAltCoverCommand/Save-apidoc) { get; set; } | Write raw coverage data to file for later processing | | [ShowGenerated](InvokeAltCoverCommand/ShowGenerated-apidoc) { get; set; } | Mark generated code with a visit count of -2 (Automatic) for the Visualizer if unvisited | | [ShowStatic](InvokeAltCoverCommand/ShowStatic-apidoc) { get; set; } | Instrument and show code that is by default skipped as trivial. | -| [Single](InvokeAltCoverCommand/Single-apidoc) { get; set; } | only record the first hit at any location (or first for that context if `-CallContext` is operating). | | [SourceLink](InvokeAltCoverCommand/SourceLink-apidoc) { get; set; } | Display sourcelink URLs rather than file paths if present. | | [StrongNameKey](InvokeAltCoverCommand/StrongNameKey-apidoc) { get; set; } | The default strong naming key to apply to instrumented assemblies | | [SummaryFormat](InvokeAltCoverCommand/SummaryFormat-apidoc) { get; set; } | Selects summary format | diff --git a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Single-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/All-apidoc.md similarity index 80% rename from docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Single-apidoc.md rename to docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/All-apidoc.md index c6022a1d9..f0c10a58c 100644 --- a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Single-apidoc.md +++ b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/All-apidoc.md @@ -1,9 +1,9 @@ -# InvokeAltCoverCommand.Single property +# InvokeAltCoverCommand.All property only record the first hit at any location (or first for that context if `-CallContext` is operating). ```csharp -public SwitchParameter Single { get; set; } +public SwitchParameter All { get; set; } ``` ## See Also diff --git a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Defer-apidoc.md b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Eager-apidoc.md similarity index 62% rename from docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Defer-apidoc.md rename to docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Eager-apidoc.md index 793253012..b72ac34af 100644 --- a/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Defer-apidoc.md +++ b/docs/AltCover.PowerShell/AltCover.Commands/InvokeAltCoverCommand/Eager-apidoc.md @@ -1,9 +1,9 @@ -# InvokeAltCoverCommand.Defer property +# InvokeAltCoverCommand.Eager property -Defers writing runner-mode coverage data until process exit. +Write runner-mode coverage data immediately. ```csharp -public SwitchParameter Defer { get; set; } +public SwitchParameter Eager { get; set; } ``` ## See Also diff --git a/docs/PowerShell-integration.md b/docs/PowerShell-integration.md index ff24e5f79..a6404fa65 100644 --- a/docs/PowerShell-integration.md +++ b/docs/PowerShell-integration.md @@ -616,7 +616,7 @@ Accept wildcard characters? false ``` #### `-Package ` -Output as file path +Package source roots ``` Required? false @@ -1129,19 +1129,19 @@ Invoke-AltCover [-Runner] -RecorderDirectory [-Cobert | RPlus | BPlus}] [-Threshold ] [-Verbosity {Off | Error | Warning | Info | Verbose}] [-WorkingDirectory ] [] -Invoke-AltCover [-AssemblyExcludeFilter ] [-AssemblyFilter ] [-AttributeFilter -] [-AttributeTopLevel ] [-BranchCover ] [-CallContext -] [-CommandLine ] [-Defer ] [-Dependency ] -[-DropReturnCode ] [-FileFilter ] [-InPlace ] -[-InputDirectory ] [-Key ] [-LineCover ] [-LocalSource -] [-MethodFilter ] [-MethodPoint ] [-MethodTopLevel -] [-OutputDirectory ] [-PathFilter ] [-Portable ] -[-Report ] [-ReportFormat {NCover | OpenCover | Json}] [-Save ] -[-ShowGenerated ] [-ShowStatic {KeepHidden | Mark | Reveal}] [-Single -] [-SourceLink ] [-StrongNameKey ] [-SymbolDirectory -] [-Trivia ] [-TypeFilter ] [-TypeTopLevel ] -[-Verbosity {Off | Error | Warning | Info | Verbose}] [-VisibleBranches ] [-ZipFile -] [] +Invoke-AltCover [-All ] [-AssemblyExcludeFilter ] [-AssemblyFilter +] [-AttributeFilter ] [-AttributeTopLevel ] [-BranchCover +] [-CallContext ] [-CommandLine ] [-Dependency ] +[-DropReturnCode ] [-Eager ] [-FileFilter ] [-InPlace +] [-InputDirectory ] [-Key ] [-LineCover ] +[-LocalSource ] [-MethodFilter ] [-MethodPoint ] +[-MethodTopLevel ] [-OutputDirectory ] [-PathFilter ] [-Portable +] [-Report ] [-ReportFormat {NCover | OpenCover | Json}] [-Save +] [-ShowGenerated ] [-ShowStatic {KeepHidden | Mark | Reveal}] +[-SourceLink ] [-StrongNameKey ] [-SymbolDirectory ] [-Trivia +] [-TypeFilter ] [-TypeTopLevel ] [-Verbosity {Off | Error | +Warning | Info | Verbose}] [-VisibleBranches ] [-ZipFile ] +[] Invoke-AltCover [-Version] [] @@ -1552,7 +1552,7 @@ Accept pipeline input? false Accept wildcard characters? false ``` -#### `-Single ` +#### `-All ` only record the first hit at any location (or first for that context if `-CallContext` is operating). @@ -1621,8 +1621,8 @@ Accept pipeline input? false Accept wildcard characters? false ``` -#### `-Defer ` -Defers writing runner-mode coverage data until process exit. +#### `-Eager ` +Write runner-mode coverage data immediately. ``` Required? false diff --git a/docs/Usage.md b/docs/Usage.md index b5750cb3e..6d942e75c 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -8,7 +8,7 @@ The full command line is ``` -AltCover [/i[nputDirectory]=VALUE] [/o[utputDirectory]=VALUE] [/y|symbolDirectory=VALUE] [/d[ependency]=VALUE] [/k[ey]=VALUE] [/sn|strongNameKey=VALUE] [/r[eport]=VALUE] [/f[ileFilter]=VALUE] [/p[athFilter]=VALUE] [/s|assemblyFilter=VALUE] [/e|assemblyExcludeFilter=VALUE] [/t[ypeFilter]=VALUE] [/m[ethodFilter]=VALUE] [/a[ttributeFilter]=VALUE] [/attributetoplevel=VALUE] [/typetoplevel=VALUE] [/methodtoplevel=VALUE] [--l[ocalSource]] [/c[allContext]=VALUE] [/reportFormat=VALUE] [--inplace] [--save] [--zipfile] [--methodpoint] [--single] [--linecover] [--branchcover] [--dropReturnCode] [--sourcelink] [--defer] [--v[isibleBranches]] [/showstatic[=VALUE]] [--showGenerated] [--trivia] [--portable] [-q] [--verbose] [--?|help|h] [-- ] [...] +AltCover [/i[nputDirectory]=VALUE] [/o[utputDirectory]=VALUE] [/y|symbolDirectory=VALUE] [/d[ependency]=VALUE] [/k[ey]=VALUE] [/sn|strongNameKey=VALUE] [/r[eport]=VALUE] [/f[ileFilter]=VALUE] [/p[athFilter]=VALUE] [/s|assemblyFilter=VALUE] [/e|assemblyExcludeFilter=VALUE] [/t[ypeFilter]=VALUE] [/m[ethodFilter]=VALUE] [/a[ttributeFilter]=VALUE] [/attributetoplevel=VALUE] [/typetoplevel=VALUE] [/methodtoplevel=VALUE] [--l[ocalSource]] [/c[allContext]=VALUE] [/reportFormat=VALUE] [--inplace] [--save] [--zipfile] [--methodpoint] [--all] [--linecover] [--branchcover] [--dropReturnCode] [--sourcelink] [--eager] [--v[isibleBranches]] [/showstatic[=VALUE]] [--showGenerated] [--trivia] [--portable] [-q] [--verbose] [--?|help|h] [-- ] [...] or AltCover Runner [/r[ecorderDirectory]=VALUE] [/w[orkingDirectory]=VALUE] [/x|executable=VALUE] [--collect] [/l[covReport]=VALUE] [/t[hreshold]=VALUE] [/c[obertura]=VALUE] [/p[ackage]=VALUE] [/o[utputFile]=VALUE] [--dropReturnCode] [/summary|teamcity[=VALUE]] [-q] [--verbose] [--?|help|h] [-- ] [...] or @@ -104,9 +104,8 @@ In detail --methodpoint Optional: record only whether a method has been visited or not. Overrides the --linecover and -- branchcover options. - --single Optional: only record the first hit at any - location, or first hit for each context if -- - callContext is operating. + --all Optional: record every hit at any location, and + for each context if --callContext is operating. --linecover Optional: Do not record branch coverage. Ignored for the --reportFormat=NCover option. Incompatible with --branchcover. @@ -117,8 +116,8 @@ In detail from a launched process. --sourcelink Optional: Display sourcelink URLs rather than file paths if present. - --defer Optional, defers writing runner-mode coverage data - until process exit. + --eager Optional, writes runner-mode coverage data + immediately. -v, --visibleBranches Optional: Hide complex internal IL branching implementation details in switch/match constructs, and just show what the source level @@ -250,8 +249,6 @@ or, for the global tool only * valid arguments for `--teamcity` are `B`, `R`, `+B`, `+R` or nothing at all (same as `B`). The letter indicates which symbol to use in the TeamCity format for branch coverage (`B` is for `Block`, which by experiment did show in the build report, and `R` is for `bRanch` which is documented, but did not show when I tried it), the optional `+` indicates that the OpenCover summary should also be emitted. -* valid arguments for `--defer` are `+`, `-` or nothing at all (same as `+`). `+` keeps coverage data in memory until process exit, `-` writes promptly to file in runner mode, i.e. acts as in previous releases since 1.6). - * `ImportModule` will print a string on Mono/non-Windows, but Windows PowerShell won't be there to make use of it. #### `-e` vs `-s` : what gives? diff --git a/docs/`dotnet-test`-integration.md b/docs/`dotnet-test`-integration.md index 844d93f31..528b1a29a 100644 --- a/docs/`dotnet-test`-integration.md +++ b/docs/`dotnet-test`-integration.md @@ -41,7 +41,7 @@ And if you want more control over what happens to the files, then is is still po * `/p:AltCoverOutputRoot=`"path of root folder for saved/instrumented output for `dotnet test`, default `$(TargetDir)`" * `/p:AltCoverZipFile="true|false"` - set "true" to store the coverage report in a `.zip` archive * `/p:AltCoverMethodPoint="true|false"` - set "true" to record only the first point of each method -* `/p:AltCoverSingle="true|false"` - set "true" to record only the first visit to each point +* `/p:AltCoverAll="true|false"` - set "true" to record every visit to each point * `/p:AltCoverLineCover="true|false"` - set "true" to record only line coverage in OpenCover format * `/p:AltCoverBranchCover="true|false"` - set "true" to record only branch coverage in OpenCover format * `/p:AltCoverSourceLink=true|false` to opt for SourceLink document URLs for tracked files