Skip to content

Commit 0e1721e

Browse files
Merge pull request #10550 from dotnet/main
Merge main into live
2 parents 4a7b2bc + 6fc2cda commit 0e1721e

File tree

9 files changed

+89
-164
lines changed

9 files changed

+89
-164
lines changed

.github/policies/disallow-edits.yml

Lines changed: 46 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -10,158 +10,50 @@ configuration:
1010
- payloadType: Pull_Request
1111
- isAction:
1212
action: Opened
13+
- or:
14+
- filesMatchPattern:
15+
pattern: xml/Microsoft.Extensions*/*
16+
matchAny: true
17+
excludedFiles:
18+
- xml/Microsoft.Extensions.FileSystemGlobbing/*
19+
- xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/*
20+
- xml/Microsoft.Extensions.FileSystemGlobbing.Internal*/*
21+
- filesMatchPattern:
22+
matchAny: true
23+
pattern: xml/System.Composition/*
24+
- filesMatchPattern:
25+
matchAny: true
26+
pattern: xml/System.Formats.Cbor/*
27+
- filesMatchPattern:
28+
matchAny: true
29+
pattern: xml/System.Formats.Nrbf/*
30+
- filesMatchPattern:
31+
matchAny: true
32+
pattern: xml/System.Net.ServerSentEvents/*
33+
- filesMatchPattern:
34+
matchAny: true
35+
pattern: xml/System.Numerics.Tensors/*
36+
- filesMatchPattern:
37+
matchAny: true
38+
pattern: xml/System.Speech/*
39+
- filesMatchPattern:
40+
matchAny: true
41+
pattern: xml/System.Runtime.Serialization/ISerializationCodeDomSurrogateProvider.xml
42+
- filesMatchPattern:
43+
matchAny: true
44+
pattern: xml/System.Runtime.Serialization/ImportOptions.xml
45+
- filesMatchPattern:
46+
matchAny: true
47+
pattern: xml/System.Runtime.Serialization/XsdDataContractExporter.xml
1348
then:
14-
- if:
15-
- includesModifiedFile:
16-
file: xml/Microsoft.Extensions*/*
17-
# TODO - These files do use this repo as source-of-truth - how to exclude them?
18-
# - xml/Microsoft.Extensions.FileSystemGlobbing/*
19-
# - xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/*
20-
# - xml/Microsoft.Extensions.FileSystemGlobbing.Internal*/*
21-
then:
22-
- addReply:
23-
reply: >-
24-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'Microsoft.Extensions' in the /// comments in the dotnet/runtime or dotnet/extensions repo instead.
25-
- if:
26-
- or:
27-
- activitySenderHasPermission:
28-
permission: None
29-
- activitySenderHasPermission:
30-
permission: Read
31-
then:
32-
- closePullRequest
33-
- if:
34-
- includesModifiedFile:
35-
file: xml/System.Composition/*
36-
then:
37-
- addReply:
38-
reply: >-
39-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Composition' in the /// comments in the dotnet/runtime repo instead.
40-
- if:
41-
- or:
42-
- activitySenderHasPermission:
43-
permission: None
44-
- activitySenderHasPermission:
45-
permission: Read
46-
then:
47-
- closePullRequest
48-
- if:
49-
- includesModifiedFile:
50-
file: xml/System.Formats.Cbor/*
51-
then:
52-
- addReply:
53-
reply: >-
54-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Formats.Cbor' in the /// comments in the dotnet/runtime repo instead.
55-
- if:
56-
- or:
57-
- activitySenderHasPermission:
58-
permission: None
59-
- activitySenderHasPermission:
60-
permission: Read
61-
then:
62-
- closePullRequest
63-
- if:
64-
- includesModifiedFile:
65-
file: xml/System.Formats.Nrbf/*
66-
then:
67-
- addReply:
68-
reply: >-
69-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Formats.Nrbf' in the /// comments in the dotnet/runtime repo instead.
70-
- if:
71-
- or:
72-
- activitySenderHasPermission:
73-
permission: None
74-
- activitySenderHasPermission:
75-
permission: Read
76-
then:
77-
- closePullRequest
78-
- if:
79-
- includesModifiedFile:
80-
file: xml/System.Net.ServerSentEvents/*
81-
then:
82-
- addReply:
83-
reply: >-
84-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Net.ServerSentEvents' in the /// comments in the dotnet/runtime repo instead.
85-
- if:
86-
- or:
87-
- activitySenderHasPermission:
88-
permission: None
89-
- activitySenderHasPermission:
90-
permission: Read
91-
then:
92-
- closePullRequest
93-
- if:
94-
- includesModifiedFile:
95-
file: xml/System.Numerics.Tensors/*
96-
then:
97-
- addReply:
98-
reply: >-
99-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Numerics.Tensors' in the /// comments in the dotnet/runtime repo instead.
100-
- if:
101-
- or:
102-
- activitySenderHasPermission:
103-
permission: None
104-
- activitySenderHasPermission:
105-
permission: Read
106-
then:
107-
- closePullRequest
108-
- if:
109-
- includesModifiedFile:
110-
file: xml/System.Speech/*
111-
then:
112-
- addReply:
113-
reply: >-
114-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'System.Speech' in the /// comments in the dotnet/runtime repo instead.
115-
- if:
116-
- or:
117-
- activitySenderHasPermission:
118-
permission: None
119-
- activitySenderHasPermission:
120-
permission: Read
121-
then:
122-
- closePullRequest
123-
- if:
124-
- includesModifiedFile:
125-
file: xml/System.Runtime.Serialization/ISerializationCodeDomSurrogateProvider.xml
126-
then:
127-
- addReply:
128-
reply: >-
129-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'ISerializationCodeDomSurrogateProvider' in the /// comments in the dotnet/runtime repo instead.
130-
- if:
131-
- or:
132-
- activitySenderHasPermission:
133-
permission: None
134-
- activitySenderHasPermission:
135-
permission: Read
136-
then:
137-
- closePullRequest
138-
- if:
139-
- includesModifiedFile:
140-
file: xml/System.Runtime.Serialization/ImportOptions.xml
141-
then:
142-
- addReply:
143-
reply: >-
144-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'ImportOptions' in the /// comments in the dotnet/runtime repo instead.
145-
- if:
146-
- or:
147-
- activitySenderHasPermission:
148-
permission: None
149-
- activitySenderHasPermission:
150-
permission: Read
151-
then:
152-
- closePullRequest
153-
- if:
154-
- includesModifiedFile:
155-
file: xml/System.Runtime.Serialization/XsdDataContractExporter.xml
156-
then:
157-
- addReply:
158-
reply: >-
159-
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates for 'XsdDataContractExporter' in the /// comments in the dotnet/runtime repo instead.
160-
- if:
161-
- or:
162-
- activitySenderHasPermission:
163-
permission: None
164-
- activitySenderHasPermission:
165-
permission: Read
166-
then:
167-
- closePullRequest
49+
- addReply:
50+
reply: >-
51+
@${issueAuthor} - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates in the /// comments in the dotnet/runtime repo (or dotnet/extensions repo) instead.
52+
- if:
53+
- or:
54+
- activitySenderHasPermission:
55+
permission: None
56+
- activitySenderHasPermission:
57+
permission: Read
58+
then:
59+
- closePullRequest

xml/System.IO/Directory.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4055,13 +4055,13 @@ The returned collection is not cached. Each call to the <xref:System.Collections
40554055
</ReturnValue>
40564056
<Parameters />
40574057
<Docs>
4058-
<summary>Retrieves the names of the logical drives on this computer in the form "&lt;drive letter&gt;:\\".</summary>
4059-
<returns>The logical drives on this computer.</returns>
4058+
<summary>Retrieves the names of the logical drives on this computer.</summary>
4059+
<returns>An array of strings representing the logical drive names.</returns>
40604060
<remarks>
40614061
<format type="text/markdown"><![CDATA[
40624062
40634063
## Remarks
4064-
GetLogicalDrives returns all of the accessible drives on a particular machine, including the floppy drive and any optical drives.
4064+
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").
40654065
40664066
For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/common-i-o-tasks).
40674067

xml/System.Numerics/Vector2.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@
663663
<Docs>
664664
<param name="values">The span of elements to assign to the vector.</param>
665665
<summary>Constructs a vector from the given <see cref="T:System.ReadOnlySpan`1" />. The span must contain at least 2 elements.</summary>
666-
<returns>To be added.</returns>
666+
<returns>A new <see cref="T:System.Numerics.Vector2" /> whose elements have the specified values.</returns>
667667
<remarks>To be added.</remarks>
668668
</Docs>
669669
</Member>

xml/System.Numerics/Vector3.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@
709709
<Docs>
710710
<param name="values">The span of elements to assign to the vector.</param>
711711
<summary>Constructs a vector from the given <see cref="T:System.ReadOnlySpan`1" />. The span must contain at least 3 elements.</summary>
712-
<returns>To be added.</returns>
712+
<returns>A new <see cref="T:System.Numerics.Vector3" /> whose elements have the specified values.</returns>
713713
<remarks>To be added.</remarks>
714714
</Docs>
715715
</Member>

xml/System.Numerics/Vector4.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@
757757
<Docs>
758758
<param name="values">The span of elements to assign to the vector.</param>
759759
<summary>Constructs a vector from the given <see cref="T:System.ReadOnlySpan`1" />. The span must contain at least 4 elements.</summary>
760-
<returns>To be added.</returns>
760+
<returns>A new <see cref="T:System.Numerics.Vector4" /> whose elements have the specified values.</returns>
761761
<remarks>To be added.</remarks>
762762
</Docs>
763763
</Member>

xml/System.Reflection.Emit/AssemblyBuilder.xml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,18 @@
7676
</Attributes>
7777
<Docs>
7878
<summary>Defines and represents a dynamic assembly.</summary>
79-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-reflection-emit-assemblybuilder">Supplemental API remarks for AssemblyBuilder</see>.</remarks>
79+
<remarks>
80+
<format type="text/markdown"><![CDATA[
81+
82+
## Remarks
83+
84+
For more information about this API, see [Supplemental API remarks for AssemblyBuilder](/dotnet/fundamentals/runtime-libraries/system-reflection-emit-assemblybuilder).
85+
86+
> [!WARNING]
87+
> `AssemblyBuilder` APIs require a fully trusted environment with trusted input, similar to other technologies such as compilers. There are no restrictions other than basic validation for generated IL that the `AssemblyBuilder` can contain. That includes validation for member name, count, and associated metadata, such as custom attributes.
88+
]]>
89+
</format>
90+
</remarks>
8091
<example>
8192
<format type="text/markdown"><![CDATA[
8293
The following code example shows how to define and use a dynamic assembly. The example assembly contains one type, `MyDynamicType`, that has a private field, a property that gets and sets the private field, constructors that initialize the private field, and a method that multiplies a user-supplied number by the private field value and returns the result.

xml/System.Reflection.Emit/ILGenerator.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,15 @@
8484
8585
MSIL is used as input to a just-in-time (JIT) compiler.
8686
87+
> [!WARNING]
88+
> There are no restrictions, other than basic validation, for ILGenerator APIs that produce method IL. If untrusted input is used for producing IL:
89+
>
90+
> - IL and metadata can contain secrets provided by the consumer.
91+
> - IL can be invalid, such as not having balanced push versus pop opcodes, or invalid operands for a given opcode.
92+
> - IL can contain any code that might, for example, deadlock, have infinite stack recursion, or have an infinite loop.
93+
> - IL can load and execute code on any other reachable assembly.
94+
>
95+
> Such code can do whatever it wishes when the method is loaded and executed. To protect against such vulnerabilities, `ILGenerator` requires a fully trusted environment with trusted input.
8796
]]></format>
8897
</remarks>
8998
</Docs>

xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@
2525
</Attributes>
2626
<Docs>
2727
<summary>Provides an AssemblyBuilder implementation that can persist assembly to a disk or stream.</summary>
28-
<remarks>To be added.</remarks>
28+
<remarks>
29+
<format type="text/markdown"><![CDATA[
30+
31+
## Remarks
32+
33+
For more information about this API, see [Persisted dynamic assemblies in .NET](/dotnet/fundamentals/runtime-libraries/system-reflection-emit-persistedassemblybuilder).
34+
35+
> [!WARNING]
36+
> `PersistedAssemblyBuilder` APIs require a fully trusted environment with trusted input, similar to other technologies such as compilers. There are no restrictions other than basic validation for generated IL that the `AssemblyBuilder` can contain. That includes validation for member name, count, and associated metadata, such as custom attributes.
37+
]]></format>
38+
</remarks>
2939
</Docs>
3040
<Members>
3141
<Member MemberName=".ctor">

xml/System/Environment.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,11 +1421,14 @@ The following example creates environment variables for the <xref:System.Environ
14211421
</ReturnValue>
14221422
<Parameters />
14231423
<Docs>
1424-
<summary>Returns an array of string containing the names of the logical drives on the current computer.</summary>
1425-
<returns>An array of strings where each element contains the name of a logical drive. For example, if the computer's hard drive is the first logical drive, the first element returned is "C:\\".</returns>
1424+
<summary>Retrieves the names of the logical drives on this computer.</summary>
1425+
<returns>An array of strings representing the logical drive names.</returns>
14261426
<remarks>
14271427
<format type="text/markdown"><![CDATA[
14281428
1429+
## Remarks
1430+
On Windows, `GetLogicalDrives` returns the names of all accessible drives on a particular machine, including any optical drives or removable media devices, in the form "\<drive letter\>:\\" (for example, "C:\\"). On Unix, it returns the paths of all filesystem mount points mounted on a particular machine (for example, "/home/user", "/media/usb").
1431+
14291432
## Examples
14301433
The following example shows how to display the logical drives of the current computer using the <xref:System.Environment.GetLogicalDrives%2A> method.
14311434

0 commit comments

Comments
 (0)