Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Update storage setting #3323

Merged
merged 1 commit into from
Aug 4, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/content/dependencies-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,13 @@ the Paket team noticed a dramatic increase of the well known "packages" folder.
Historically one way was to tell Paket that you only want to compile for `framework: net45`.
However, this doesn't prevent netstandard dependencies in all situations.
On the other side more features are provided by Paket and the packages folder has become more and more redundant:

- Load scripts can reference the files in the global cache
- csproj/fsproj files can references files in the global cache
- netcore project files don't require any explicit dll-references

Therefore, the paket team decided to make the "packages" folder opt-out.

> This feature is currently considered beta

You can opt-out of generating the `packages` folder by using the `storage` option:

```paket
Expand All @@ -219,8 +219,13 @@ source https://nuget.org/api/v2
nuget jQuery
```

The storage 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).
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).

The storage option has three values:

- `storage: packages` (the default, relevant for FAKE 5 where the default for inline-dependencies is `storage: none`)
- `storage: none` disable the packages folder and use the global NuGet cache (default in FAKE 5 inline-dependencies)
- `storage: symlink` use the packages folder but use symlinks instead of physical files

```paket
// make a symlink instead copy the packages.
Expand Down