From ef1c0d7d5102afd348995c463e493d00ae719859 Mon Sep 17 00:00:00 2001
From: xtqqczze <45661989+xtqqczze@users.noreply.github.com>
Date: Thu, 30 Apr 2020 17:35:54 +0100
Subject: [PATCH] Document why `PackageVersion` is used in
 `PowerShell.Common.props` (#12523)

Co-Authored-By: Nick Guerrera <nicholg@microsoft.com>
---
 PowerShell.Common.props | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/PowerShell.Common.props b/PowerShell.Common.props
index 177eef8784..6cae0785ec 100644
--- a/PowerShell.Common.props
+++ b/PowerShell.Common.props
@@ -56,12 +56,12 @@
       <ProductVersion>$(PSCoreFormattedVersion)</ProductVersion>
 
       <!--
-            We have explicitly assign 'PackageVersion'
-            because there is a bug: 'PackageVersion' is correctly assigned as 'Version' in 'NuGet.targets'
-            but then immediately redefined as '1.0.0'.
-            Tracking Issue https://github.com/dotnet/sdk/issues/1557
+        We have to explicitly assign 'PackageVersion' here because we're changing 'Version' in a target.
+        Before any targets have run (during static evaluation), 'Version' will have defaulted to '1.0.0' and PackageVersion will have defaulted to 'Version'.
+        See https://github.com/dotnet/sdk/issues/1557
       -->
       <PackageVersion>$(PSCoreBuildVersion)</PackageVersion>
+
       <ApplicationIcon Condition="$(ProductVersion.Contains('preview'))">..\..\assets\Powershell_av_colors.ico</ApplicationIcon>
       <ApplicationIcon Condition="!$(ProductVersion.Contains('preview'))">..\..\assets\Powershell_black.ico</ApplicationIcon>