Skip to content

Commit

Permalink
add link to source link breaking change (#9510)
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren authored Dec 15, 2023
1 parent 29ff220 commit 6dc0dcf
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions xml/System.Reflection/AssemblyInformationalVersionAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,21 @@
<Docs>
<summary>Defines additional version information for an assembly manifest.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The attribute defined by this class attaches additional version information to an assembly. If this attribute is applied to an assembly, the string it specifies can be obtained at run time by using the <xref:System.Windows.Forms.Application.ProductVersion%2A?displayProperty=nameWithType> property. The string is also used in the path and registry key provided by the <xref:System.Windows.Forms.Application.UserAppDataPath%2A?displayProperty=nameWithType> property and the <xref:System.Windows.Forms.Application.UserAppDataRegistry%2A?displayProperty=nameWithType> property. If the <xref:System.Reflection.AssemblyInformationalVersionAttribute> is not applied to an assembly, the version number specified by the <xref:System.Reflection.AssemblyVersionAttribute> attribute is used instead.
Although you can specify any text, a warning message appears on compilation if the string is not in the format used by the assembly version number, or if it is in that format but contains wildcard characters. This warning is harmless.
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> Starting with the .NET 8 SDK, commit information is included in this attribute's value. This behavior applies to projects that target any .NET version. For more information, see [Source Link included in the .NET SDK](/dotnet/core/compatibility/sdk/8.0/source-link).
The attribute defined by this class attaches additional version information to an assembly.
If the <xref:System.Reflection.AssemblyInformationalVersionAttribute> is not applied to an assembly, the version number specified by the <xref:System.Reflection.AssemblyVersionAttribute> attribute is used instead.
Although you can specify any text, a warning message appears on compilation if the string is not in the format used by the assembly version number, or if it is in that format but contains wildcard characters. This warning is harmless.
For Windows Forms apps, you can obtain the string this attribute specifies at run time by using the <xref:System.Windows.Forms.Application.ProductVersion?displayProperty=nameWithType> property. The string is also used in the path and registry key provided by the <xref:System.Windows.Forms.Application.UserAppDataPath?displayProperty=nameWithType> property and the <xref:System.Windows.Forms.Application.UserAppDataRegistry?displayProperty=nameWithType> property.
]]></format>
</remarks>
<related type="Article" href="/dotnet/standard/assembly/versioning">Assembly versioning</related>
Expand Down Expand Up @@ -122,11 +130,12 @@
<param name="informationalVersion">The assembly version information.</param>
<summary>Initializes a new instance of the <see cref="T:System.Reflection.AssemblyInformationalVersionAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The informational version provides additional version information for an assembly, in string format. It is for informational purposes only and is not used at run time. Although you can specify any text, a warning message appears on compilation if the string is not in the format used by the assembly version number, or if it is in that format but contains wildcard characters. This warning is harmless.
<format type="text/markdown"><![CDATA[
## Remarks
The informational version provides additional version information for an assembly, in string format. It is for informational purposes only and is not used at run time. Although you can specify any text, a warning message appears on compilation if the string is not in the format used by the assembly version number, or if it is in that format but contains wildcard characters. This warning is harmless.
]]></format>
</remarks>
<related type="Article" href="/dotnet/standard/assembly/versioning">Assembly versioning</related>
Expand Down

0 comments on commit 6dc0dcf

Please sign in to comment.