NuGet Docs

Updated Wiki: Home

howarddierking — Thu, 12 Jul 2012 23:27:03 GMT

NuGet Documentation

Markdown based ASP.NET Web Pages documentation system for NuGet.

Important: this project was for the old version of NuGet docs. The new docs site is hosted on https://github.com/NuGet/NuGetDocs. Please do not file new bugs here as they will likely not be seen.

The documentation for NuGet is hosted at http://docs.nuget.org/.

The source code for the docs are located at https://github.com/NuGet/NuGetDocs/. If you want to help us update our docs, simply go to the docs page on GitHub and edit the docs in the browser.

New Post: NuGet Packages Documentation

gibsonsdad — Thu, 12 Jul 2012 22:49:18 GMT

I am just starting to program with .Net, and need to use some NuGet packages. Is there documentation on the various packages, and if so, where do I find them?

Created Issue: Doc on nuget pack / metadata [45]

aldion — Wed, 11 Jul 2012 18:21:56 GMT

from http://nuget.codeplex.com/workitem/2416

"If the nuspec is in the same directory as the project file, the pack command will use metadata from the file."
"It would be cool of you guys if you could update the documentation to make clear that the nuspec and project files are supposed to be in the same directory for this to work :)"

Created Issue: Document pack workflow w/ dependencies [44]

aldion — Tue, 10 Jul 2012 23:20:54 GMT

redirected from http://nuget.codeplex.com/workitem/2405

Created Issue: Add documentation about how to connect to the feed behind a proxy [43]

danliu — Fri, 08 Jun 2012 23:25:53 GMT

The fix to issue http://nuget.codeplex.com/workitem/1924 is adding a new feature to nuget.

We need to add documentation to docs.nuget.org so people will know how to use this feature while working behind a proxy.

New Post: How to determine if a project/solution uses Nuget?

Avikage — Tue, 05 Jun 2012 09:00:13 GMT

Hi,

Im looking for a way for determine weather projects are using nuget or not.

Is looking at the solution file the correct way to do this? By finding :

Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{58B5C2B1-E68E-4C10-A7B3-D2F02113C8FA}" ProjectSection(SolutionItems) = preProject .nuget\NuGet.exe = .nuget\NuGet.exe .nuget\NuGet.targets = .nuget\NuGet.targets EndProjectSectionEndProject

Thanks.

New Post: Handling File Renames

fathomy — Thu, 16 Feb 2012 03:55:15 GMT

Thank you for the tip. It was really helpful.

____________________

Internet Marketing Ideas

Updated Wiki: Home

Haacked — Mon, 24 Oct 2011 18:29:08 GMT

NuGet Documentation

Markdown based ASP.NET Web Pages documentation system for NuGet.

The documentation for NuGet is hosted at http://docs.nuget.org/.

The source code for the docs are located at https://github.com/NuGet/NuGetDocs/. If you want to help us update our docs, simply go to the docs page on GitHub and edit the docs in the browser.

Source code checked in, #92d55fc08274

Haacked — Wed, 12 Oct 2011 22:25:01 GMT

Merging changes from default into vnext to get them in sync.

Created Issue: Update docs to note that nuget pack ignores files/folders that start with a dot character [42]

Haacked — Mon, 03 Oct 2011 04:05:10 GMT

See issue http://nuget.codeplex.com/workitem/1582 for details.

Created Issue: Updated docs with info about safe updates during install [41]

Haacked — Mon, 03 Oct 2011 03:40:08 GMT

From here: http://nuget.codeplex.com/workitem/1583

Documentation states that, for dependencies that are already installed:

"If the dependency is already installed, then one of two things happens:
* If the installed dependency is within the version range, then nothing more needs to happen. The dependency is met.
* If the installed dependency is outside of the version range, installation fails. (Version leveling in a future version of NuGet will fix this.)"

This doesn't seem to be the actual behavior, based on this:

PM> Install-Package Newtonsoft.Json -Version 4.0.2
Successfully installed 'Newtonsoft.Json 4.0.2'.
Successfully added 'Newtonsoft.Json 4.0.2' to Foo.Tests.ApiTests.

PM> Install-Package RestSharp -Version 101.3
Attempting to resolve dependency 'Newtonsoft.Json'.
Successfully installed 'Newtonsoft.Json 4.0.3'.
Successfully installed 'RestSharp 101.3'.
Successfully removed 'Newtonsoft.Json 4.0.2' from Foo.Tests.ApiTests.
Successfully added 'Newtonsoft.Json 4.0.3' to Foo.Tests.ApiTests.
Successfully added 'RestSharp 101.3' to Foo.Tests.ApiTests.
Successfully uninstalled 'Newtonsoft.Json 4.0.2'.

The dependency in RestSharp.nuspec does not have any particular version number.
<dependency id="Newtonsoft.Json" />

Ah, I think the docs are outdated. I think we do "safe" upgrades based on the semantics of SemVer, http://semver.org/. Assuming a version of X.Y.Z, Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.

We figured you probably want bug fixes. Of course, not every package author follows this, but we're going to try and encourage it more and more. If the package author did break you, please contact them and tell them adding breaking changes without incrementing the Major (or at least Minor) version is not nice.

In the meanwhile, if you want to lock that version, you can by hand editing packages.config and adding an allowedVersions attribute with a version range. In your case:

<package id="NewtonSoft.Json" allowedVersion="[4.0.2]" />

Created Issue: Add an overview of the NuGet ecosystem to Docs [40]

XavierDecoster — Fri, 30 Sep 2011 20:47:15 GMT

starting point could be http://www.xavierdecoster.com/post/2011/09/30/An-overview-of-the-NuGet-ecosystem.aspx

Source code checked in, #f329748d6bf8

aldion — Thu, 29 Sep 2011 05:52:04 GMT

metadata copyrights should be copyright on nuspec reference

Source code checked in, #4880606440c7

Haacked — Thu, 29 Sep 2011 05:43:08 GMT

Marcin's pull request on project template wizards and preinstalled nuget packages

Source code checked in, #01015608e97b

marcind — Wed, 28 Sep 2011 22:39:54 GMT

Add docs page for Packages in Visual Studio Templates.

Source code checked in, #a7bb3df32c19

aldion — Wed, 28 Sep 2011 20:08:59 GMT

Fixing a sample that had NuPack namespace

Commented Issue: Code Review page 404 [29]

aldion — Wed, 28 Sep 2011 18:59:52 GMT

The page http://docs.nuget.org/docs/contribute/Code-Reviews, which is linked from several other locations in the NuGet docs, (such as from here: http://docs.nuget.org/docs/contribute/contributing-to-nuget) returns a 404. I can't find any other sources on the NuGet docs site about code reviews.
Comments: nevermind. the page is old it should probably be taken down since it returns in search engines... :)

Commented Issue: Code Review page 404 [29]

aldion — Wed, 28 Sep 2011 18:58:09 GMT

The page http://docs.nuget.org/docs/contribute/Code-Reviews, which is linked from several other locations in the NuGet docs, (such as from here: http://docs.nuget.org/docs/contribute/contributing-to-nuget) returns a 404. I can't find any other sources on the NuGet docs site about code reviews.
Comments: Note: the page exist in "vnext" : http://preview.docs.nuget.org/docs/contribute/code-reviews but not in "default" : http://docs.nuget.org/docs/contribute/code-reviews this should be fixed once the branches are merged.

Commented Issue: documentation for nuspec file -exclude misleading [39]

aldion — Wed, 28 Sep 2011 18:43:57 GMT

follow up to http://nuget.codeplex.com/workitem/1498
Comments: Fixed with changeset 3064c431e43b

Edited Issue: documentation for nuspec file -exclude misleading [39]

aldion — Wed, 28 Sep 2011 18:43:57 GMT

follow up to http://nuget.codeplex.com/workitem/1498