Merge pull request #15 from cpsusie/v1.0_prerelease

Readying for 1.0 release

Author: cpsusie

Advantages of Using Large Mutable Structs.docx

@@ -97,7 +97,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="HighPrecisionTimeStamps" Version="1.0.0" />
+    <PackageReference Include="HighPrecisionTimeStamps" Version="1.0.0.1" />
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

Advantages of Using Large Mutable Structs.pdf

@@ -74,8 +74,8 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
-    <Reference Include="HighPrecisionTimeStamps, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <HintPath>..\packages\HighPrecisionTimeStamps.1.0.0\lib\netstandard2.0\HighPrecisionTimeStamps.dll</HintPath>
+    <Reference Include="HighPrecisionTimeStamps, Version=1.0.0.1, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\packages\HighPrecisionTimeStamps.1.0.0.1\lib\netstandard2.0\HighPrecisionTimeStamps.dll</HintPath>
     </Reference>
     <Reference Include="JetBrains.Annotations, Version=2021.2.0.0, Culture=neutral, PublicKeyToken=1010a0d8d6380325, processorArchitecture=MSIL">
       <HintPath>..\packages\JetBrains.Annotations.2021.2.0\lib\net20\JetBrains.Annotations.dll</HintPath>

DotNetVault Description v1.0.docx

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="HighPrecisionTimeStamps" version="1.0.0" targetFramework="net48" />
+  <package id="HighPrecisionTimeStamps" version="1.0.0.1" targetFramework="net48" />
   <package id="JetBrains.Annotations" version="2021.2.0" targetFramework="net48" />
   <package id="System.Buffers" version="4.5.1" targetFramework="net48" />
   <package id="System.Memory" version="4.5.4" targetFramework="net48" />

DotNetVault Description.pdf

@@ -11,9 +11,9 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DotNetVault.Vsix", "DotNetV
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{6273AC00-D6E4-4119-93DE-0F0EAE73D450}"
 	ProjectSection(SolutionItems) = preProject
-		DotNetVault Description latest.docx = DotNetVault Description latest.docx
-		DotNetVault Description.pdf = DotNetVault Description.pdf
 		DotNetVault.sln.DotSettings = DotNetVault.sln.DotSettings
+		DotNetVault_Description_latest_draft.docx = DotNetVault_Description_latest_draft.docx
+		DotNetVault_Description_Latest_Draft.pdf = DotNetVault_Description_Latest_Draft.pdf
 		DotNetVault_Description_v1.0.pdf = DotNetVault_Description_v1.0.pdf
 		license.txt = license.txt
 		README.md = README.md

DotNetVault.Test/DotNetVault.Test.csproj

@@ -9,6 +9,7 @@
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -19,25 +20,25 @@
 
   <PropertyGroup>
     <PackageId>DotNetVault</PackageId>
-    <PackageVersion>0.9.9.0-alpha</PackageVersion>
+    <PackageVersion>1.0.0.0</PackageVersion>
     <Owners>CJM Screws, LLC</Owners>
     <Authors>Christopher Susie</Authors>
     <PackageProjectUrl>https://github.com/cpsusie/DotNetVault</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/cpsusie/DotNetVault</RepositoryUrl>
+    <RepositoryUrl>https://github.com/cpsusie/DotNetVault.git</RepositoryUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Description>
       Synchronization Library and Static Analysis Tool for C# 8
 
       DotNetVault is a library and static code analysis tool that makes managing shared mutable state in multi-threaded applications more manageable and less error prone.  It also provides a common abstraction over several commonly used synchronization mechanisms, allowing you to change from one underlying type to another (such as from lock free synchronization to mutex/monitor lock based) without needing to refactor your code. Where errors do still occur, they are easier to locate and identify.
 
-      The project description (a detailed design document) can be read here: https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVault_Description_Latest_Draft.pdf.
+      The project description (a detailed design document) can be read here: https://github.com/cpsusie/DotNetVault/blob/master/DotNetVault_Description_v1.0.pdf.
 
       A quick start guide for installation (Windows, Vs 2019+) can be found here: https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/QuickStart_Install_VS2019_Windows.md.
 
       A quick start guide for installation (Tested on Amazon Linux, Rider 2019.3.1+) can be found here: https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/Quick_Start_Install_Rider_Amazon_Linux.md.
 
       A guided tour / quick start guide for this project's functionality can be found here: https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/Quick_Start_Functionality_Tour.md 
-    </Description>
+</Description>
     <PackageReleaseNotes>
       RELEASE NOTES VERSION 1.0:
       Official Release of DotNetVault.  See prior release notes for features.  This release updates the official documentation for this release version.
@@ -52,16 +53,17 @@
       * Update example code project to demonstrate.
     </PackageReleaseNotes>
     <Copyright>Copyright © 2019-2021 CJM Screws, LLC</Copyright>
-    <PackageTags>DotNetVault, analyzers, synchronization, thread-safety, threadsafe, deadlock, deadlock-prevention</PackageTags>
+    <PackageTags>DotNetVault, analyzers, synchronization, thread-safety, threadsafe, deadlock, deadlock-prevention, threads, raii, multi-threaded</PackageTags>
     <NoPackageAnalysis>true</NoPackageAnalysis>
     <LangVersion>8.0</LangVersion>
-    <Version>0.9.9.0</Version>
+    <Version>1.0.0.0</Version>
     <AssemblyName>DotNetVault</AssemblyName>
     <RootNamespace>DotNetVault</RootNamespace>
     <Company>CJM Screws, LLC</Company>
-    <AssemblyVersion>0.9.9.0</AssemblyVersion>
-    <FileVersion>0.9.9.0</FileVersion>
+    <AssemblyVersion>1.0.0.0</AssemblyVersion>
+    <FileVersion>1.0.0.0</FileVersion>
     <PackageLicenseFile>license.txt</PackageLicenseFile>
+    <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
@@ -132,14 +134,11 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="HighPrecisionTimeStamps" Version="1.0.0">
+    <PackageReference Include="HighPrecisionTimeStamps" Version="1.0.0.1">
       <GeneratePathProperty>true</GeneratePathProperty>
       <IncludeAssets>all</IncludeAssets>
+      <IncludeInPackage>true</IncludeInPackage>
     </PackageReference>
-    <None Include="$(PkgHighPrecisionTimeStamps)\lib\netstandard2.0\HighPrecisionTimeStamps.dll">
-      <Link>HighPrecisionTimeStamps.dll</Link>
-      <CopyToOutputDirectory>always</CopyToOutputDirectory>
-    </None>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="JetBrains.Annotations" Version="2021.2.0" />
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.2" PrivateAssets="all" />
@@ -160,7 +159,7 @@
 
   <ItemGroup>
     <None Update="tools\*.ps1" CopyToOutputDirectory="Always" Pack="true" PackagePath="" />
-    <None Include="$(OutputPath)\HighPrecisionTimeStamps.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
+    <None Include="$(PkgHighPrecisionTimeStamps)\lib\netstandard2.0\*.dll"  Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false"/>
     <None Include="$(OutputPath)\license.txt" Pack="true" PackagePath="Docs" Visible="false" />
     <None Include="$(OutputPath)\Quick_Start_Functionality_Tour.md" Pack="true" PackagePath="Docs" Visible="false" />
     <None Include="$(OutputPath)\Quick_Start_Install_Rider_Amazon_Linux.md" Pack="true" PackagePath="Docs" Visible="false" />

DotNetVault.Vsix/DotNetVault.Vsix.csproj

@@ -1,4 +1,4 @@
-RELEASE NOTES VERSION 1.0:
+RELEASE NOTES FOR VERSION 1.0:
       Official Release of DotNetVault.  See prior release notes for features.  This release updates the official documentation for this release version.
 
 RELEASE NOTES VERSION 0.2.5.18:

DotNetVault.Vsix/packages.config

@@ -28,7 +28,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="DotNetVault" Version="0.9.9-alpha" />
     <PackageReference Include="System.Collections.Immutable" Version="5.0.0" />
   </ItemGroup>
 

DotNetVault.sln

@@ -42,8 +42,6 @@
   </ItemGroup>
 
   <ItemGroup>
-	<PackageReference Include="DotNetVault" Version="0.9.9-alpha" />
-    <PackageReference Include="HighPrecisionTimeStamps" Version="1.0.0" />
     <PackageReference Include="JetBrains.Annotations" Version="2021.2.0" />
     <PackageReference Include="System.Collections.Immutable" Version="5.0.0" />
   </ItemGroup>

DotNetVault/DotNetVault.csproj

@@ -15,7 +15,7 @@ namespace ExampleCodePlayground
     using MonoStampSrc = HpTimeStamps.MonotonicTimeStampUtil<MonotonicContext>;
     //The following attribute will cause the compiler to emit a warning telling you the locations of the two configurable 
     //vault-safe whitelist files.
-    //[ReportWhiteListLocations]
+    [ReportWhiteListLocations]
     class Program
     {
         static void Main()

DotNetVault/RELEASE.txt

@@ -1,13 +1,13 @@
-# DotNetVault Quick Start Installation Guide Visual Studio 2019 (Windows 10)  
+# DotNetVault Version 1.0 Quick Start Installation Guide Visual Studio 2019 (Windows 10)  
 
 1. Open Visual Studio and Create a new .NET Core 3.1+ or .NET Framework 4.8 Console Application.  
 2.  **If you chose .NET Framework 4.8**, open the .csproj file and add the following Line `<LangVersion>8.0</LangVersion>` under each “Platform/Config” PropertyGroup as shown in highlight below.  This is unnecessary if you chose a .NET Core 3.1+ based Console Application. 
 
-     ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_1.png?raw=true)
+     ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_1.png?raw=true)
 
 3. Right click on your project and chose “Manage NuGet packages”.  Click on the Browse option, enter “dotnetvault” into the search block, select DotNetVault, then click “Install”.  
 
-     ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_2.png?raw=true)
+     ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_2.png?raw=true)
 
 4. You are now set up to use DotNetVault in your project.  
 
@@ -53,20 +53,20 @@
 
     * Change the Configuration to **Release** and Build the project:  
 
-        ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_3.png?raw=true)
+        ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_3.png?raw=true)
           
     * *If you have installed everything correctly, the build should* **fail**.  If it builds, consult Visual Studio documentation for how to enable Roslyn Analyzers.  Do not attempt to use this library without static analysis enabled.  Assuming it does not build, you should see the following as a result of your build attempt:  
 
-        ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_4.png?raw=true)
+        ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_4.png?raw=true)
         
     * The error is that you must **guard** the return value from a *Lock()* or *SpinLock()* method (or any other method whose return value you choose to annotate with the *UsingMandatory* attribute) with a using statement or declaration.  Failure to ensure that the lock is promptly released would cause a serious error in your program … it would timeout whenever in the future you attempted to obtain the lock.  
     * To fix the error, on line 16, change “var lck =…” to “using var lck =…” as shown then Build again.  This time, the build should succeed as shown:  
 
-        ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_5.png?raw=true)
+        ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_5.png?raw=true)
           
     * Now you should be able to run the application as shown:  
 
-        ![](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_6.png?raw=true)  
+        ![](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/dotnet_vault_install_vs2019_win/pic_6.png?raw=true)  
     
- 6. Congratulations, you have successfully built an application using DotNetVault.  Next, we will look at a QuickStart application that shows the very basics of what can be done with this library and its integrated static analyzer.  Move on to the [functionality tour](https://github.com/cpsusie/DotNetVault/blob/v0.2.5.x/DotNetVaultQuickStart/DotNetVault%20Quick%20Start%20Functionality%20Tour%20%E2%80%93%20JetBrains%20Rider%20(Amazon%20Linux).md) next.  
+ 6. Congratulations, you have successfully built an application using DotNetVault.  Next, we will look at a QuickStart application that shows the very basics of what can be done with this library and its integrated static analyzer.  Move on to the [functionality tour](https://github.com/cpsusie/DotNetVault/blob/master/DotNetVaultQuickStart/DotNetVault%20Quick%20Start%20Functionality%20Tour%20%E2%80%93%20JetBrains%20Rider%20(Amazon%20Linux).md) next.