Skip to content

Commit 1681dea

Browse files
author
Kraig Brockschmidt
authored
Merge branch 'master' into kraigb
2 parents 7acf34e + 4a93ce8 commit 1681dea

15 files changed

+61
-30
lines changed

docs/API/package-publish-resource.md

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

134134
Status Code | Meaning
135135
----------- | -------
136-
204 | The package is now listed
136+
200 | The package is now listed
137137
404 | No package with the provided `ID` and `VERSION` exists

docs/Consume-Packages/Configuring-NuGet-Behavior.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ NuGet's behavior is driven by the accumulated settings in one or more `NuGet.Con
2222

2323
| Scope | NuGet.Config file location | Description |
2424
| --- | --- | --- |
25-
| Project | Project folder or any folder up to the drive root | In a project folder, settings apply only to that project. In parent folders that contain multiple projects subfolders, settings apply to all projects in those subfolders. |
26-
| User | Windows: %APPDATA%\NuGet\NuGet.Config<br/>Mac/Linux: ~/.nuget/NuGet.Config | Settings apply to all operations, but are overridden by any project-level settings. When using CLI commands, you can specify a different config file using the `-configFile` switch to ignore any settings in the default user-level file. |
25+
| Project | Current folder (aka Project folder) or any folder up to the drive root.| In a project folder, settings apply only to that project. In parent folders that contain multiple projects subfolders, settings apply to all projects in those subfolders. |
26+
| User | Windows: %APPDATA%\NuGet\NuGet.Config<br/>Mac/Linux: ~/.nuget/NuGet.Config | Settings apply to all operations, but are overridden by any project-level settings. |
2727
| Computer | Windows: %ProgramFiles(x86)%\NuGet\Config<br/>Mac/Linux: $XDG_DATA_HOME (typically ~/.local/share) | Settings apply to all operations on the computer, but are overriden by any user- or project-level settings. |
2828

2929
Notes for earlier versions of NuGet:
3030
- NuGet 3.3 and earlier used a `.nuget` folder for solution-wide settings. This file not used in NuGet 3.4+.
31-
- For NuGet 2.6 to 3.x, the computer-level config file on Windows was located in %ProgramData%\NuGet\Config[\\{IDE}[\\{Version}[\\{SKU}]]]\NuGet.Config, where *{IDE}* can be *VisualStudio*, *{Version}* was the Visual Studio version such as *14.0*, and *{SKU}* is either *Community*, *Pro*, or *Enterprise*. To migrate settings to NuGet 4.0+, simply copy the config file to %ProgramFiles(x86)%\NuGet\Config. On Linus, this previous location was /etc/opt, and on Mac, /Library/Application Support.
31+
- For NuGet 2.6 to 3.x, the computer-level config file on Windows was located in %ProgramData%\NuGet\Config[\\{IDE}[\\{Version}[\\{SKU}]]]\NuGet.Config, where *{IDE}* can be *VisualStudio*, *{Version}* was the Visual Studio version such as *14.0*, and *{SKU}* is either *Community*, *Pro*, or *Enterprise*. To migrate settings to NuGet 4.0+, simply copy the config file to %ProgramFiles(x86)%\NuGet\Config. On Linux, this previous location was /etc/opt, and on Mac, /Library/Application Support.
3232

3333
## Changing config settings
3434

docs/Consume-Packages/Dependency-Resolution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ ms.reviewer:
1818

1919
Any time a package is installed or reinstalled, which includes being installed as part of a [restore](../consume-packages/package-restore.md) process, NuGet also installs any additional packages on which that first package depends.
2020

21-
Those immediate dependencies might then also have dependencies on their own, which can continue to an arbitrary depth. This produces what's called a *dependency graph* that describes the relationships between packages are all levels.
21+
Those immediate dependencies might then also have dependencies on their own, which can continue to an arbitrary depth. This produces what's called a *dependency graph* that describes the relationships between packages at all levels.
2222

23-
When multiple packages have the same dependency, then the same package ID can appear in the graph multiple times, potentially with different version constraints. However, only one version of a given package can be used in a project, so NuGet must choose which version is be used. The exact process depends on the package reference format being used.
23+
When multiple packages have the same dependency, then the same package ID can appear in the graph multiple times, potentially with different version constraints. However, only one version of a given package can be used in a project, so NuGet must choose which version is used. The exact process depends on the package reference format being used.
2424

2525
## Dependency resolution with PackageReference
2626

docs/Create-Packages/Creating-a-Package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ nuget locals -list global-packages
136136
Go into any *package\version* folder, copy the `.nupkg` file to a `.zip` file, then open that `.zip` file and examine the `.nuspec` within it.
137137

138138
> [!Note]
139-
> When creating a `.nuspec` from a Visual Studio project, the manifest contains tokens that are be replaced with information from the project when the package is built. See [Creating the .nuspec from a Visual Studio project](#from-a-visual-studio-project).
139+
> When creating a `.nuspec` from a Visual Studio project, the manifest contains tokens that are replaced with information from the project when the package is built. See [Creating the .nuspec from a Visual Studio project](#from-a-visual-studio-project).
140140
141141
## Creating the .nuspec file
142142

docs/Policies/NuGet-FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,9 @@ If a package does not specify the licensing terms, contact the package owner dir
162162

163163
## Managing packages on nuget.org
164164

165-
**Can I edit package metadata after it's been uploaded? Why do you recommend editing the nuspec and uploading a new package for making changes to package metadata?**
165+
**Can I edit package metadata after it's been uploaded? Why do you require editing the nuspec and uploading a new package for making changes to package metadata?**
166166

167-
NuGet will be implementing package signing. A design principle of package signing is that signed package content must be immutable, which includes the nuspec. Editing the package metadata results in changes to the nuspec, invalidating existing signatures. We recommend modifying existing workflows to not require editing the package metadata after the package has been created.
167+
NuGet requires all packages to be signed. A design principle of package signing is that signed package content must be immutable, which includes the nuspec. Editing the package metadata results in changes to the nuspec, invalidating existing signatures. We recommend modifying existing workflows to not require editing the package metadata after the package has been created.
168168

169169
Note that dependencies listed for your package are generated automatically from the package itself and cannot be edited.
170170

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,14 @@ Once you have a `.nupkg` file, you publish it to nuget.org using the `push` comm
109109

110110
1. Once logged in, select your user name (on the upper right), then select **API Keys**.
111111

112-
1. Select **Create**, provide a name for your key, select **Select Scopes > Push**Under **API Key**, enter * for **Glob pattern**, then select **Create**.
112+
1. Select **Create**, provide a name for your key, select **Select Scopes > Push** under **API Key**, enter * for **Glob pattern**, then select **Create**.
113113

114114
1. Once the key is created, select **Copy** to retrieve the access key you'll need in the CLI:
115115

116116
![Copying the API key to the clipboard](media/QS_Create-02-APIKey.png)
117117

118118
> [!Warning]
119-
> Save your key in a secure location and keep is a secret. If your key is accidentally revealed, you can always regenerate it at any time. You can also remove the API key if you no longer want to push packages via the CLI.
119+
> Save your key in a secure location and keep it secret. If your key is accidentally revealed, you can regenerate it at any time. You can also remove the API key if you no longer want to push packages via the CLI.
120120
121121
1. At a command prompt, run the following command, specifying your package name and replacing the key with the value copied in step 4:
122122

docs/Quickstart/Use-a-Package.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ NuGet packages are units of reusable code that other developers make available t
2222

2323
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.
2424

25-
The remainder of this topic walks through the process of using the Package Manager UI to install the popular [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/) package in a Universal Windows Platform (UWP) project. It then shows an example of using the package. You use a similar same workflow for virtually every NuGet package you use in a project.
25+
The remainder of this topic walks through the process of using the Package Manager UI to install the popular [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/) package in a Universal Windows Platform (UWP) project. It then shows an example of using the package. You use a similar workflow for other NuGet packages.
2626

2727
- [Install pre-requisites](#install-pre-requisites)
2828
- [Create a project](#create-a-project)
2929
- [Add the Newtonsoft.Json NuGet package](#add-the-newtonsoftjson-nuget-package)
3030
- [Use the Newtonsoft.Json API in the app](#use-the-newtonsoftjson-api-in-the-app)
3131

3232
> [!Tip]
33-
> **Start with nuget.org**: Installing packages from nuget.org is a common workflow that .NET developers use to find components they can reuse in their own applications. You can always search nuget.org directly or find and install packages within Visual Studio as shown in this topic.
33+
> **Start with nuget.org**: Installing packages from nuget.org is a common workflow that .NET developers use to find components they can use in their own applications. You can always search nuget.org directly or find and install packages within Visual Studio as shown in this topic.
3434
3535
## Install pre-requisites
3636

docs/Reference/Errors-and-Warnings.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,37 @@ ms.reviewer:
1313
- anangaur
1414
- karann-msft
1515
- unniravindranathan
16+
17+
f1_keywords:
18+
- "NU1000"
19+
- "NU1001"
20+
- "NU1002"
21+
- "NU1003"
22+
- "NU1100"
23+
- "NU1101"
24+
- "NU1102"
25+
- "NU1103"
26+
- "NU1104"
27+
- "NU1105"
28+
- "NU1106"
29+
- "NU1107"
30+
- "NU1108"
31+
- "NU1201"
32+
- "NU1202"
33+
- "NU1203"
34+
- "NU1401"
35+
- "NU1500"
36+
- "NU1501"
37+
- "NU1502"
38+
- "NU1503"
39+
- "NU1601"
40+
- "NU1602"
41+
- "NU1603"
42+
- "NU1604"
43+
- "NU1605"
44+
- "NU1608"
45+
- "NU1701"
46+
- "NU1801"
1647
---
1748

1849
# Errors and warnings
@@ -128,7 +159,7 @@ The errors and warnings listed here are available only with [PackageReference-ba
128159
| **Common causes** | Packages contain dependency on exact versions of a package instead of open-ended ranges. |
129160
| **Example message** | *Unable to satisfy conflicting requests for {id}: {conflict path} Framework: {target graph}* |
130161

131-
<a name="NU1107"></a>
162+
<a name="NU1107"></a>
132163

133164
### NU1107 (Previously NU1607)
134165

@@ -258,8 +289,6 @@ The errors and warnings listed here are available only with [PackageReference-ba
258289

259290
## Resolver conflict warnings
260291

261-
[NU1608](#nu1608)
262-
263292
### NU1608
264293

265294
| | |
@@ -270,8 +299,6 @@ The errors and warnings listed here are available only with [PackageReference-ba
270299

271300
## Package fallback warnings
272301

273-
[NU1701](#nu1701)
274-
275302
### NU1701
276303

277304
| | |
@@ -282,8 +309,6 @@ The errors and warnings listed here are available only with [PackageReference-ba
282309

283310
## Feed warnings
284311

285-
[NU1801](#nu1801)
286-
287312
### NU1801
288313

289314
| | |

docs/Reference/Package-Versioning.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ For nuget.org, a package is defined as a SemVer v2.0.0 package if either of the
8787
If you upload a SemVer v2.0.0-specific package to nuget.org, the package is invisible to older clients and available to only the following NuGet clients:
8888

8989
- NuGet 4.3.0+
90-
- Visual Studio 2017 version 15.3+
90+
- Visual Studio 2017 version 15.3+
91+
- Visual Studio 2015 with [NuGet VSIX v3.6.0](https://dist.nuget.org/visualstudio-2015-vsix/latest/NuGet.Tools.vsix)
9192
- dotnet.exe (.NET SDK 2.0.0+)
9293

9394
Third-party clients:

docs/Schema/nuspec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ These elements must appear within a `<metadata>` element.
8080

8181
### Optional metadata elements
8282

83-
These elements must appear within a `<metadata>` element.
83+
These elements may appear within a `<metadata>` element.
8484

8585
#### Single elements
8686

@@ -540,7 +540,7 @@ These files are specified with a set of attributes that describe how they should
540540
| **exclude** | A semicolon-delimited list of files or file patterns to exclude from the `src` location. The wildcard character `*` is allowed, and the double wildcard `**` implies a recursive folder search. |
541541
| **buildAction** | The build action to assign to the content item for MSBuild, such as `Content`, `None`, `Embedded Resource`, `Compile`, etc. The default is `Compile`. |
542542
| **copyToOutput** | A Boolean indicating whether to copy content items to the build output folder. The default is false. |
543-
| **flatten** | A Boolean indicating whether to copy content items to a single folder in the build output (true), or to preserve the folder structure in the package (false). The default is false. |
543+
| **flatten** | A Boolean indicating whether to copy content items to a single folder in the build output (true), or to preserve the folder structure in the package (false). This flag only works when copyToOutput flag is set to true. The default is false. |
544544

545545
When installing a package, NuGet applies the child elements of `<contentFiles>` from top to bottom. If multiple entries match the same file then all entries are applied. The top-most entry overrides the lower entries if there is a conflict for the same attribute.
546546

0 commit comments

Comments
 (0)