update documentation and RELEASE_NOTES.

fsprojects · May 24, 2017 · 148d73b · 148d73b
1 parent cf5c947
commit 148d73b
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,10 +1,18 @@
-#### 5.0.0-beta005 - 23.05.2017
+#### 5.0.0-beta006 - 24.05.2017
 * BUGFIX: Fixed dotnetcore integration:
   * Paket now properly understands runtime and reference assemblies
   * Paket now understands the runtime graph and restores runtime dependencies
   * New API `InstallModel.GetRuntimeAssemblies` and `InstallModel.GetRuntimeLibraries` can be used to retrieve the correct assets for a particular RID and TFM
 * New command `paket generate-nuspec`
 * New Command: `FixNuspecs` - Can fix a list of nuspec files now
+* New restriction system (https://github.com/fsprojects/Paket/pull/2336):
+  * Paket is now more accurate in calculating restrictions and referencing libraries
+  * Paket will convert (lock-)files to a new syntax (but still understands the old syntax), we might revert this within the beta phase
+  * This should fix a bunch of edge cases and invalid behavior in combination with portable profiles and netstandard
+  * Add support for net403 (required for some portable profiles)
+* PERFORMANCE: Improved performance by pre-loading requests (https://github.com/fsprojects/Paket/pull/2336)
+* PERFORMANCE: Report performance in a more detailed way (https://github.com/fsprojects/Paket/pull/2336)
+* BREAKING CHANGE: Paket simplify no longer support simplifying restrictions (https://github.com/fsprojects/Paket/pull/2336)
 * BREAKING CHANGE: Paket.PowerShell is no longer supported
 * BREAKING CHANGE: `InstallModel` API changed and Paket.Core.dll users might need to adapt
 * DEPRECATED: `FixNuspec` function is now obsolete, use `FixNuspecs` instead

diff --git a/docs/content/dependencies-file.md b/docs/content/dependencies-file.md
@@ -92,6 +92,10 @@ Sometimes you don't want to generate dependencies for older framework versions.
 
     nuget Example >= 2.0 // only .NET 3.5 and .NET 4.0
 
+It means
+
+> Paket, I only compile for 'net35' and 'net40', please leave out all other stuff I don't need to compile for this set of frameworks.
+
 #### Automatic framework detection
 
 Paket can detect the target frameworks from your project and then limit the installation to these target frameworks. You can control this in the [`paket.dependencies` file](dependencies-file.html):

diff --git a/docs/content/nuget-dependencies.md b/docs/content/nuget-dependencies.md
@@ -183,6 +183,16 @@ Sometimes you don't want to generate dependencies for older framework versions.
     nuget Example >= 2.0 framework: net35, net40  // .NET 3.5 and .NET 4.0
     nuget Example >= 2.0 framework: >= net45      // .NET 4.5 and above
 
+> Note: This feature is deprecated and can be seen as an expert feature. 
+> Using framework restrictions on single packages might make you projects uncompilable.
+> The recommended way is to globally (on a group) specifiy the frameworks you want to compile for.
+
+This feature basically tells paket to only consider the specified frameworks for this package.
+It means 
+
+> Paket I use 'Example' only to compile against 'net35' and 'net40'.
+> I never need this package to compile for another framework like 'net45'."
+
 ### Putting the version no. into the path
 
 If you need to be NuGet compatible and want to have the version no. in the package path you can do the following:

diff --git a/docs/content/references-files.md b/docs/content/references-files.md
@@ -66,6 +66,18 @@ Sometimes you don't want to generate dependencies for older framework versions.
     Newtonsoft.Json framework: net35, net40
     DotNetZip framework: >= net45           
 
+> Note: This feature is deprecated and can be seen as an expert feature. 
+> Using framework restrictions on single packages might make you projects uncompilable.
+> The recommended way is to globally (on a group) specifiy the frameworks you want to compile for.
+
+This feature basically tells paket to only consider the specified frameworks for this package on this particular project.
+The resolution will not be modified when restrictions are specified in the reference file.
+It means 
+
+> In this project 'Newtonsoft.Json' is only required when compiling against 'net35' or 'net40'.
+> I never need this package to compile for another framework like 'net45', therefore don't add references for other frameworks.
+
+
 ## Redirects settings
 
 You can instruct Paket to create assembly binding redirects for NuGet packages: