Skip to content

Commit 6dc0dcf

Browse files
authored
add link to source link breaking change (#9510)
1 parent 29ff220 commit 6dc0dcf

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

xml/System.Reflection/AssemblyInformationalVersionAttribute.xml

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,21 @@
6767
<Docs>
6868
<summary>Defines additional version information for an assembly manifest.</summary>
6969
<remarks>
70-
<format type="text/markdown"><![CDATA[
71-
72-
## Remarks
73-
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.
74-
75-
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.
76-
70+
<format type="text/markdown"><![CDATA[
71+
72+
## Remarks
73+
74+
> [!NOTE]
75+
> 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).
76+
77+
The attribute defined by this class attaches additional version information to an assembly.
78+
79+
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.
80+
81+
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.
82+
83+
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.
84+
7785
]]></format>
7886
</remarks>
7987
<related type="Article" href="/dotnet/standard/assembly/versioning">Assembly versioning</related>
@@ -122,11 +130,12 @@
122130
<param name="informationalVersion">The assembly version information.</param>
123131
<summary>Initializes a new instance of the <see cref="T:System.Reflection.AssemblyInformationalVersionAttribute" /> class.</summary>
124132
<remarks>
125-
<format type="text/markdown"><![CDATA[
126-
127-
## Remarks
128-
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.
129-
133+
<format type="text/markdown"><![CDATA[
134+
135+
## Remarks
136+
137+
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.
138+
130139
]]></format>
131140
</remarks>
132141
<related type="Article" href="/dotnet/standard/assembly/versioning">Assembly versioning</related>

0 commit comments

Comments
 (0)