Skip to content

Commit bdcd204

Browse files
author
Kraig Brockschmidt
authored
Merge pull request NuGet#651 from NuGet/master
Publish to live
2 parents 8c647f8 + 55d3cac commit bdcd204

11 files changed

+30
-33
lines changed

docs/API/package-publish-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ X-NuGet-ApiKey | Header | string | yes | For example, `X-NuGet-ApiKey: {USE
146146

147147
Status Code | Meaning
148148
----------- | -------
149-
204 | The package is now listed
149+
200 | The package is now listed
150150
404 | No package with the provided `ID` and `VERSION` exists

docs/Consume-Packages/Reinstalling-and-Updating-Packages.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,16 @@ Updating and reinstalling packages is accomplished as follows:
2727
| Package Manager UI | On the **Updates** tab, select one or more packages and select **Update** | On the **Installed** tab, select a package, record its name, then select **Uninstall**. Switch to the **Browse** tab, search for the package name, select it, then select **Install**). |
2828
| nuget.exe CLI | `nuget update` command | For all packages, delete the package folder, then run `nuget install`. For a single package, delete the package folder and use `nuget install <id>` to reinstall the same one. |
2929

30-
In this topic:
30+
In this article:
31+
3132
- [When to Reinstall a Package](#when-to-reinstall-a-package)
3233
- [Constraining upgrade versions](#constraining-upgrade-versions)
3334

3435
## When to Reinstall a Package
3536

3637
1. **Broken references after package restore**: If you've opened a project and restored NuGet packages, but still see broken references, try reinstalling each of those packages.
3738
1. **Project is broken due to deleted files**: NuGet does not prevent you from removing items added from packages, so it's easy to inadvertently modify contents installed from a package and break your project. To restore the project, reinstall the affected packages.
38-
1. **Package update broke the project**: If an update to a package breaks a project, the failure is generally caused by a dependency package which may have also been. To restore the state of the dependency, reinstall that specific package.
39+
1. **Package update broke the project**: If an update to a package breaks a project, the failure is generally caused by a dependency package which may have also been updates. To restore the state of the dependency, reinstall that specific package.
3940
1. **Project retargeting or upgrade**: This can be useful when a project has been retargeted or upgraded and if the package requires reinstallation due to the change in target framework. NuGet 2.7 and later shows a build error in such cases immediately after project retargeting, and subsequent build warnings let you know that the package may need to be reinstalled. For project upgrade, NuGet shows an error in the Project Upgrade Log.
4041
1. **Reinstalling a package during its development**: Package authors often need to reinstall the same version of package they're developing to test the behavior. The `Install-Package` command does not provide an option to force a reinstall, so use `Update-Package -reinstall` instead.
4142

docs/Quickstart/Create-and-Publish-a-Package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Every NuGet package needs a manifest&mdash;a `.nuspec` file&mdash;to describe it
5454
nuget spec
5555
```
5656
57-
1. Open the file in a text editor. The manifest looks something like the code below, where tokens in the form *$`<token>`$* are be replaced during the packaging process with values from the project's Properties/AssemblyInfo.cs file. For more details on tokens, see [Creating a .nuspec file](../create-packages/creating-a-package.md#creating-the-nuspec-file).
57+
1. Open the file in a text editor. The manifest looks something like the code below, where tokens in the form `<token>` (such as `$id$`) are be replaced during the packaging process with values from the project's Properties/AssemblyInfo.cs file. For more details on tokens, see [Creating a .nuspec file](../create-packages/creating-a-package.md#creating-the-nuspec-file).
5858
5959
```xml
6060
<?xml version="1.0"?>

docs/Quickstart/Use-a-Package.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ ms.reviewer:
1717

1818
# Install and use a package
1919

20+
NuGet packages are units of reusable code that other developers make available to you for use in your projects. See [What is NuGet?](../What-is-NuGet.md) for background.
21+
2022
[!INCLUDE [install-methods](../includes/install-methods.md)]
2123

2224
Once installed, refer to the package in code with `using <namespace>` where \<namespace\> is specific to the package you're using. Once the reference is made, you can call the package through its API.

docs/Schema/nuget-config-file.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ In this topic:
3535
- [packageRestore section](#packagerestore-section)
3636
- [solution section](#solution-section)
3737
- [Package source sections](#package-source-sections):
38-
- [packageSources](#packagesources)
39-
- [packageSourceCredentials](#packagesourcecredentials)
40-
- [apikeys](#apikeys)
41-
- [disabledPackageSources](#disabledpackagesources)
42-
- [activePackageSource](#activepackagesource)
38+
-[packageSources](#packagesources)
39+
- [packageSourceCredentials](#packagesourcecredentials)
40+
- [apikeys](#apikeys)
41+
- [disabledPackageSources](#disabledpackagesources)
42+
- [activePackageSource](#activepackagesource)
4343
- [Using environment variables](#using-environment-variables)
4444
- [Example config file](#example-config-file)
4545

@@ -62,7 +62,6 @@ Note: `dependencyVersion` and `repositoryPath` apply only to projects using `pac
6262
| defaultPushSource | Identifies the URL or path of the package source that should be used as the default if no other package sources are found for an operation. |
6363
| http_proxy http_proxy.user http_proxy.password no_proxy | Proxy settings to use when connecting to package sources; `http_proxy` should be in the format `http://<username>:<password>@<domain>`. Passwords are encrypted and cannot be added manually. For `no_proxy`, the value is a comma-separated list of domains the bypass the proxy server. You can alternately use the http_proxy and no_proxy environment variables for those values. For additional details, see [NuGet proxy settings](http://skolima.blogspot.com/2012/07/nuget-proxy-settings.html) (skolima.blogspot.com). |
6464

65-
6665
**Example**:
6766

6867
```xml
@@ -74,7 +73,6 @@ Note: `dependencyVersion` and `repositoryPath` apply only to projects using `pac
7473
</config>
7574
```
7675

77-
7876
## bindingRedirects section
7977

8078
Configures whether NuGet does automatic binding redirects when a package is installed.
@@ -119,7 +117,6 @@ Controls whether the `packages` folder of a solution is included in source contr
119117
| --- | --- |
120118
| disableSourceControlIntegration | A Boolean indicating whether to ignore the packages folder when working with source control. The default value is false. |
121119

122-
123120
**Example**:
124121

125122
```xml
@@ -128,13 +125,13 @@ Controls whether the `packages` folder of a solution is included in source contr
128125
</solution>
129126
```
130127

131-
132128
## Package source sections
133129

134130
The `packageSources`, `packageSourceCredentials`, `apikeys`, `activePackageSource`, and `disabledPackageSources` all work together to configure how NuGet works with package repositories during install, restore, and update operations.
135131

136132
The [`nuget sources` command](../tools/cli-ref-sources.md) is generally used to manage these settings, except for `apikeys` which is managed using the [`nuget setapikey` command](../tools/cli-ref-setapikey.md).
137133

134+
Note that the source URL for nuget.org is `https://api.nuget.org/v3/index.json`.
138135

139136
### packageSources
140137

@@ -154,7 +151,6 @@ Lists all known package sources.
154151
</packageSources>
155152
```
156153

157-
158154
### packageSourceCredentials
159155

160156
Stores usernames and passwords for sources, typically specified with the `-username` and `-password` switches with `nuget sources`. Passwords are encrypted by default unless the `-storepasswordincleartext` option is also used.
@@ -193,7 +189,7 @@ When using unencrypted passwords:
193189
<Test_x0020_Source>
194190
<add key="Username" value="user" />
195191
<add key="ClearTextPassword" value="hal+9ooo_da!sY" />
196-
</Test_x0020_Source>
192+
</Test_x0020_Source>
197193
</packageSourceCredentials>
198194
```
199195

@@ -213,7 +209,6 @@ Stores keys for sources that use API key authentication, as set with the [`nuget
213209
</apikeys>
214210
```
215211

216-
217212
### disabledPackageSources
218213

219214
Identified currently disabled sources. May be empty.
@@ -222,8 +217,6 @@ Identified currently disabled sources. May be empty.
222217
| --- | --- |
223218
| (name of source) | A Boolean indicating whether the source is disabled. |
224219

225-
226-
227220
**Example:**
228221

229222
```xml
@@ -267,7 +260,6 @@ Similarly, if `HOME` on Mac/Linux is set to `/home/myStuff`, then `$HOME/NuGetRe
267260

268261
If an environment variable is not found, NuGet uses the literal value from the configuration file.
269262

270-
271263
## Example config file
272264

273265
Below is an example `NuGet.Config` file that illustrates a number of settings:

docs/Schema/nuspec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,8 @@ And you build an assembly whose `AssemblyName` is `LoggingLibrary` with the `Rel
168168
The `<dependencies>` element within `<metadata>` contains any number of `<dependency>` elements that identify other packages upon which the top-level package depends. The attributes for each `<dependency>` are as follows:
169169

170170
| Attribute | Description |
171-
| --- | --- |
172-
| `id` | (Required) The package ID of the dependency. |
171+
| --- | --- |
172+
| `id` | (Required) The package ID of the dependency, such as "EntityFramework" and "NUnit", which is the name of the package nuget.org shows on a package page. |
173173
| `version` | (Required) The range of versions acceptable as a dependency. See [Package versioning](../reference/package-versioning.md#version-ranges-and-wildcards) for exact syntax. |
174174
| include | A comma-delimited list of include/exclude tags (see below) indicating of the dependency to include in the final package. The default value is `none`. |
175175
| exclude | A comma-delimited list of include/exclude tags (see below) indicating of the dependency to exclude in the final package. The default value is `all`. Tags specified with `exclude` take precedence over those specified with `include`. For example, `include="runtime, compile" exclude="compile"` is the same as `include="runtime"`. |

docs/Tools/Package-Manager-Console.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ ms.topic: article
1010
ms.prod: nuget
1111
ms.technology: null
1212
ms.assetid: 2b92b119-6861-406c-82af-9d739af230e4
13+
f1_keywords:
14+
- "vs.nuget.packagemanager.console"
1315

1416
# optional metadata
1517

docs/Tools/Package-Manager-UI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ f1_keywords:
1212
- "vs.toolsoptionspages.nuget_package_manager"
1313
- "vs.toolsoptionspages.nuget_package_manager.general"
1414
- "vs.toolsoptionspages.nuget_package_manager.package_sources"
15+
- "vs.nuget.packagemanager.ui"
1516
description: Instructions for using the NuGet Package Manager UI in Visual Studio for working with NuGet packages.
1617
keywords: NuGet UI, NuGet package manager UI, NuGet in Visual Studio, managing NuGet packages, NuGet user interface, package manager in Visual Studio
1718
ms.reviewer:

docs/Tools/cli-ref-config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ nuget config -AsPath <name> [options]
3030

3131
where `<name>` and `<value>` specify a key-value pair to be set in the configuration. You can specify as many pairs as desired. To remove a value, specify the name and the `=` sign but no value.
3232

33+
For allowable key names, see the [NuGet config file reference](../Schema/nuget-config-file.md).
34+
3335
In NuGet 3.4+, `<value>` can use [environment variables](cli-ref-environment-variables.md).
3436

3537
## Options

docs/Tools/cli-ref-sources.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ ms.reviewer:
2727

2828
Manages the list of sources located in `%AppData%\NuGet\NuGet.Config` or the specified configuration file.
2929

30+
Note that the source URL for nuget.org is `https://api.nuget.org/v3/index.json`.
31+
3032
## Usage
3133

3234
```
@@ -35,7 +37,6 @@ nuget sources <operation> -Name <name> -Source <source>
3537

3638
where `<operation>` is one of *List, Add, Remove, Enable, Disable,* or *Update*, `<name>` is the name of the source, and `<source>` is the source's URL.
3739

38-
3940
## Options
4041

4142
| Option | Description |

0 commit comments

Comments
 (0)