Skip to content

Commit

Permalink
Merge pull request #97 from agross/docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
forki committed Sep 15, 2014
2 parents da559b2 + 440b46c commit 1d955fd
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/content/dependencies_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ NOT SUPPORTED YET

The `~>` "twiddle-wakka" operator is borrowed from [bundler](http://bundler.io/). It is used to specify a version range.

It translates to "use the minimum version specified, but allow upgrades to `<version specified>, last part chopped off, last number incremented by 1`". In other words, the maximum allowed version is computed as follows: Chop off the last part of the version specified, and allow the remaining last part to increase. Pin any of the parts before that.
It translates to "use the minimum version specified, but allow upgrades up to, but not including, `<version specified>, last part chopped off, last number incremented by 1`". In other words, allow the last part stated explicitly to increase, but pin any of the elements before that.

Let us illustrate:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If the lock file already exists, it will not be regenerated.

You may have [`paket.references` files](references_files.html) next to your Visual Studio projects to have Paket automatically add references for the packages noted in that file.

All of the files involved ([`paket.dependencies`](dependencies_files.html), [`paket.lock`](lock_file.html) and [`paket.references`](references_files.html)) should be committed to your version control system.
All of the files involved ([`paket.dependencies`](dependencies_file.html), [`paket.lock`](lock_file.html) and [`paket.references`](references_files.html)) should be committed to your version control system.

Determine if there are package updates available:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/references_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The file whitelists any dependencies from the [`paket.lock`](lock_file.html) set

For each MSBuild project alongside a `paket.references`, [`paket install`](paket_install.html) and [`paket update`](paket_update.html) will add references to the dependencies listed in `paket.references` *and all their indirect dependencies*.

The references injected into the MSBuild project represent the complete set of rules specified within the package for each `lib` and `Content` item; each reference is `Conditon`al on an MSBuild expression predicated on the project's active framework etc. This allows you to change the target version of the MSBuild project (either within Visual Studio or e.g. as part of a multi-pass build) without reinstalling dependencies or incurring an impenetrable set of diffs.
The references injected into the MSBuild project represent the complete set of rules specified within the package for each `lib` and `Content` item; each reference is `Condition`al on an MSBuild expression predicated on the project's active framework etc. This allows you to change the target version of the MSBuild project (either within Visual Studio or e.g. as part of a multi-pass build) without reinstalling dependencies or incurring an impenetrable set of diffs.

## File name conventions

Expand Down

0 comments on commit 1d955fd

Please sign in to comment.