Skip to content

Commit 65abd67

Browse files
authored
Merge pull request #2271 from gewarren/patch-1
Update PackageIconUrl info to be current
2 parents edf4295 + 7d4b5c7 commit 65abd67

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/reference/msbuild-targets.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Note that the `Owners` and `Summary` properties from `.nuspec` are not supported
5858
| LicenseUrl | PackageLicenseUrl | empty | `PackageLicenseUrl` is deprecated, use the PackageLicenseExpression or PackageLicenseFile property |
5959
| ProjectUrl | PackageProjectUrl | empty | |
6060
| Icon | PackageIcon | empty | You need to explicitly pack the referenced icon image file.|
61-
| IconUrl | PackageIconUrl | empty | For the best downlevel experience, `PackageIconUrl` should be specified in addition to `PackageIcon`. Longer term, `PackageIconUrl` will be deprecated. |
61+
| IconUrl | PackageIconUrl | empty | `PackageIconUrl` is deprecated in favor of `PackageIcon`. However, for the best downlevel experience, you should specify `PackageIconUrl` in addition to `PackageIcon`. |
6262
| Tags | PackageTags | empty | Tags are semi-colon delimited. |
6363
| ReleaseNotes | PackageReleaseNotes | empty | |
6464
| Repository/Url | RepositoryUrl | empty | Repository URL used to clone or retrieve source code. Example: *https://github.com/NuGet/NuGet.Client.git* |
@@ -113,14 +113,12 @@ To suppress package dependencies from generated NuGet package, set `SuppressDepe
113113

114114
### PackageIconUrl
115115

116-
`PackageIconUrl` will be deprecated in favor of the new [`PackageIcon`](#packageicon) property.
117-
118-
Starting with NuGet 5.3 & Visual Studio 2019 version 16.3, `pack` will raise [NU5048](./errors-and-warnings/nu5048.md) warning if the package metadata only specifies `PackageIconUrl`.
116+
`PackageIconUrl` is deprecated in favor of the [`PackageIcon`](#packageicon) property. Starting with NuGet 5.3 and Visual Studio 2019 version 16.3, `pack` raises the [NU5048](./errors-and-warnings/nu5048.md) warning if the package metadata only specifies `PackageIconUrl`.
119117

120118
### PackageIcon
121119

122120
> [!Tip]
123-
> You should specify both `PackageIcon` and `PackageIconUrl` to maintain backward compatibility with clients and sources that do not yet support `PackageIcon`. Visual Studio will support `PackageIcon` for packages coming from a folder-based source in a future release.
121+
> To maintain backward compatibility with clients and sources that don't yet support `PackageIcon`, specify both `PackageIcon` and `PackageIconUrl`. Visual Studio supports `PackageIcon` for packages coming from a folder-based source.
124122
125123
#### Packing an icon image file
126124

0 commit comments

Comments
 (0)