Skip to content

Commit 6ec1622

Browse files
authored
Merge pull request #3323 from fsprojects/matthid-patch-1
[DOCS] Update storage setting
2 parents 38b50c1 + 3caa86b commit 6ec1622

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/content/dependencies-file.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,13 @@ the Paket team noticed a dramatic increase of the well known "packages" folder.
202202
Historically one way was to tell Paket that you only want to compile for `framework: net45`.
203203
However, this doesn't prevent netstandard dependencies in all situations.
204204
On the other side more features are provided by Paket and the packages folder has become more and more redundant:
205+
205206
- Load scripts can reference the files in the global cache
206207
- csproj/fsproj files can references files in the global cache
207208
- netcore project files don't require any explicit dll-references
209+
208210
Therefore, the paket team decided to make the "packages" folder opt-out.
209211

210-
> This feature is currently considered beta
211-
212212
You can opt-out of generating the `packages` folder by using the `storage` option:
213213

214214
```paket
@@ -219,8 +219,13 @@ source https://nuget.org/api/v2
219219
nuget jQuery
220220
```
221221

222-
The storage option may be overriden by packages.
223-
However, the behavior is undefined and may change (please open an issue if you depend on the current behavior or we break you).
222+
The option may be overriden by packages. However, the behavior is undefined and may change (please open an issue if you depend on the current behavior or we break you).
223+
224+
The storage option has three values:
225+
226+
- `storage: packages` (the default, relevant for FAKE 5 where the default for inline-dependencies is `storage: none`)
227+
- `storage: none` disable the packages folder and use the global NuGet cache (default in FAKE 5 inline-dependencies)
228+
- `storage: symlink` use the packages folder but use symlinks instead of physical files
224229

225230
```paket
226231
// make a symlink instead copy the packages.

0 commit comments

Comments
 (0)