From ccf961659bc0544453f7a975ade4b47e25eac68b Mon Sep 17 00:00:00 2001 From: Ahmet Ibrahim Aksoy Date: Wed, 2 Oct 2024 13:41:30 +0200 Subject: [PATCH 1/6] Port undocumented WebSocket APIs --- xml/System.Net.WebSockets/ClientWebSocketOptions.xml | 5 ++++- xml/System.Net.WebSockets/WebSocketCreationOptions.xml | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.WebSockets/ClientWebSocketOptions.xml b/xml/System.Net.WebSockets/ClientWebSocketOptions.xml index 9a675c876d2..ec280808114 100644 --- a/xml/System.Net.WebSockets/ClientWebSocketOptions.xml +++ b/xml/System.Net.WebSockets/ClientWebSocketOptions.xml @@ -463,7 +463,10 @@ System.TimeSpan - To be added. + + The timeout to use when waiting for the peer's PONG in response to us sending a PING; or or to disable waiting for peer's response, and use an unsolicited PONG as a Keep-Alive heartbeat instead. + The default is . + To be added. To be added. diff --git a/xml/System.Net.WebSockets/WebSocketCreationOptions.xml b/xml/System.Net.WebSockets/WebSocketCreationOptions.xml index 468d0cf8de2..7b74c90fe3f 100644 --- a/xml/System.Net.WebSockets/WebSocketCreationOptions.xml +++ b/xml/System.Net.WebSockets/WebSocketCreationOptions.xml @@ -141,7 +141,10 @@ System.TimeSpan - To be added. + + The timeout to use when waiting for the peer's PONG in response to us sending a PING; or or to disable waiting for peer's response, and use an unsolicited PONG as a Keep-Alive heartbeat instead. + The default is . + To be added. To be added. From 29d9aa69831bc73f06fe227371e37c3bb51a5f44 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Wed, 2 Oct 2024 13:46:46 -0700 Subject: [PATCH 2/6] Add note about when to use HGlobal related allocator APIs. (#10484) --- xml/System.Runtime.InteropServices/Marshal.xml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/xml/System.Runtime.InteropServices/Marshal.xml b/xml/System.Runtime.InteropServices/Marshal.xml index 0bdb28fcf2c..a8ac4b0506e 100644 --- a/xml/System.Runtime.InteropServices/Marshal.xml +++ b/xml/System.Runtime.InteropServices/Marshal.xml @@ -303,6 +303,9 @@ [!IMPORTANT] +> This native memory allocator is a legacy API that should be used exclusively when called for by specific Win32 APIs on the Windows platform. When targeting .NET 6 or later, use the class on all platforms to allocate native memory. When targeting .NET 6 or earlier, use on all platforms to allocate native memory. + is one of two memory allocation methods in the class. ( is the other.) This method exposes the Win32 [LocalAlloc](https://go.microsoft.com/fwlink/?LinkId=148628) function from Kernel32.dll. When calls `LocalAlloc`, it passes a `LMEM_FIXED` flag, which causes the allocated memory to be locked in place. Also, the allocated memory is not zero-filled. @@ -383,6 +386,9 @@ [!IMPORTANT] +> This native memory allocator is a legacy API that should be used exclusively when called for by specific Win32 APIs on the Windows platform. When targeting .NET 6 or later, use the class on all platforms to allocate native memory. When targeting .NET 6 or earlier, use on all platforms to allocate native memory. + is one of two memory allocation methods in the class. ( is the other.) This method exposes the Win32 [LocalAlloc](https://go.microsoft.com/fwlink/?LinkID=148628) function from Kernel32.dll. When calls `LocalAlloc`, it passes a `LMEM_FIXED` flag, which causes the allocated memory to be locked in place. Also, the allocated memory is not zero-filled. @@ -2656,6 +2662,9 @@ [!IMPORTANT] +> This native memory allocator is a legacy API that should be used exclusively when called for by specific Win32 APIs on the Windows platform. When targeting .NET 6 or later, use the class on all platforms to allocate native memory. When targeting .NET 6 or earlier, use on all platforms to allocate native memory. + You can use to free any memory from the global heap allocated by , , or any equivalent unmanaged API method. If the `hglobal` parameter is the method does nothing. exposes the [LocalFree](https://go.microsoft.com/fwlink/?LinkId=148640) function from Kernel32.DLL, which frees all bytes so that you can no longer use the memory pointed to by `hglobal`. @@ -9569,6 +9578,9 @@ On .NET 6 and later versions, this method is functionally equivalent to [!IMPORTANT] +> This native memory allocator is a legacy API that should be used exclusively when called for by specific Win32 APIs on the Windows platform. When targeting .NET 6 or later, use the class on all platforms to allocate native memory. When targeting .NET 6 or earlier, use on all platforms to allocate native memory. + is one of two memory reallocation API methods in the class. ( is the other.) This method exposes the Win32 [GlobalReAlloc](https://go.microsoft.com/fwlink/?LinkId=148780) function from Kernel32.dll. The returned pointer can differ from the original. If it is different, the contents of the original memory block have been copied to the new block, and the original memory block has been freed. From 3631f2e8441c0e891fc0de1f29819cf948ecf946 Mon Sep 17 00:00:00 2001 From: David Engel Date: Wed, 2 Oct 2024 14:37:56 -0700 Subject: [PATCH 3/6] Update CODEOWNERS for System.Data and System.Data.SqlClient --- .github/CODEOWNERS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 1e635749b1e..a503eb49031 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -25,10 +25,10 @@ /xml/System.Activities*/ @dotnet/docs /xml/System.AddIn*/ @dotnet/docs /xml/System.ComponentModel.DataAnnotations*/ @ajcvickers -/xml/System.Data*/ @ajcvickers @david-engel @JRahnama +/xml/System.Data*/ @ajcvickers /xml/System.Data.Odbc/ @ajcvickers /xml/System.Data.OleDb/ @ajcvickers -/xml/System.Data.SqlClient/ @david-engel @JRahnama +/xml/System.Data.SqlClient/ @david-engel @cheenamalhotra /xml/System.Deployment*/ @dotnet/docs /xml/System.Device*/ @dotnet/docs /xml/System.Dynamic*/ @dotnet/docs From 681f78b6a8012b71bd040ad1b97f57b73d776204 Mon Sep 17 00:00:00 2001 From: David Engel Date: Wed, 2 Oct 2024 14:45:56 -0700 Subject: [PATCH 4/6] Update mention-owners.yml --- .github/policies/mention-owners.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/policies/mention-owners.yml b/.github/policies/mention-owners.yml index 44a4dca48d3..26cbeaab3af 100644 --- a/.github/policies/mention-owners.yml +++ b/.github/policies/mention-owners.yml @@ -391,9 +391,8 @@ configuration: then: - mentionUsers: mentionees: - - davoudeshtehari + - cheenamalhotra - david-engel - - jrahnama replyTemplate: >- Tagging subscribers to this area: ${mentionees} assignMentionees: False From f985b666980b5983b22d629fb50b43fe45336cb2 Mon Sep 17 00:00:00 2001 From: Miha Zupan Date: Thu, 3 Oct 2024 11:21:05 +0200 Subject: [PATCH 5/6] Update `HttpHeaders.Add` exception docs (#10493) * Update `HttpHeaders.Add` exception docs * Update HttpHeaders.xml --- xml/System.Net.Http.Headers/HttpHeaders.xml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Http.Headers/HttpHeaders.xml b/xml/System.Net.Http.Headers/HttpHeaders.xml index fa3338b91af..ffac89a801b 100644 --- a/xml/System.Net.Http.Headers/HttpHeaders.xml +++ b/xml/System.Net.Http.Headers/HttpHeaders.xml @@ -151,6 +151,8 @@ method inserts a new header into the list of header name/value pairs. @@ -166,7 +168,7 @@ -or- -New line characters in header values must be followed by a white-space character. +The header value format is invalid for this header name, or the header does not support multiple values. @@ -220,7 +222,9 @@ New line characters in header values must be followed by a white-space character method inserts a new header into the list of header name/value pairs. @@ -234,7 +238,7 @@ New line characters in header values must be followed by a white-space character -or- -New line characters in header values must be followed by a white-space character. +The header value format is invalid for this header name, or the header does not support multiple values. From 8022d8a6a37d92e81f4b11403a20f865dc7fcf74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 3 Oct 2024 18:50:31 -0700 Subject: [PATCH 6/6] Port System.IO.Compression docs from RC1 (#10485) * Port System.IO.Compression docs from RC1 * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../BrotliCompressionOptions.xml | 9 +++++---- xml/System.IO.Compression/BrotliStream.xml | 15 +++++++++++---- xml/System.IO.Compression/DeflateStream.xml | 11 +++++++---- xml/System.IO.Compression/GZipStream.xml | 11 +++++++---- .../ZLibCompressionOptions.xml | 15 ++++++++++----- .../ZLibCompressionStrategy.xml | 14 ++++++++------ xml/System.IO.Compression/ZLibStream.xml | 11 +++++++---- 7 files changed, 55 insertions(+), 31 deletions(-) diff --git a/xml/System.IO.Compression/BrotliCompressionOptions.xml b/xml/System.IO.Compression/BrotliCompressionOptions.xml index eda3aae2103..dbd8661ba66 100644 --- a/xml/System.IO.Compression/BrotliCompressionOptions.xml +++ b/xml/System.IO.Compression/BrotliCompressionOptions.xml @@ -14,7 +14,7 @@ - To be added. + Provides compression options to be used with . To be added. @@ -51,9 +51,10 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the compression quality for a Brotli compression stream. + The compression quality for a Brotli compression stream. The default value is 4. + The higher the quality, the slower the compression. The range is from 0 to 11. + The value is less than 0 or greater than 11. diff --git a/xml/System.IO.Compression/BrotliStream.xml b/xml/System.IO.Compression/BrotliStream.xml index a7c70f0fa65..8419cd6bfbc 100644 --- a/xml/System.IO.Compression/BrotliStream.xml +++ b/xml/System.IO.Compression/BrotliStream.xml @@ -77,6 +77,8 @@ Initializes a new instance of the class by using the specified stream and compression level. To be added. .NET 7 and later: is not defined in the enumeration. + + is . @@ -132,11 +134,14 @@ - To be added. - To be added. - To be added. - To be added. + The stream to which compressed data is written. + The Brotli options for fine tuning the compression stream. + + to leave the stream open after disposing the object; otherwise, . + Initializes a new instance of the class by using the specified stream and compression options, and optionally leaves the stream open. To be added. + + or is . @@ -174,6 +179,8 @@ Initializes a new instance of the class by using the specified stream and compression level, and optionally leaves the stream open. To be added. .NET 7 and later: is not defined in the enumeration. + + is . diff --git a/xml/System.IO.Compression/DeflateStream.xml b/xml/System.IO.Compression/DeflateStream.xml index bd7e1ec71aa..d6b2c69fc0b 100644 --- a/xml/System.IO.Compression/DeflateStream.xml +++ b/xml/System.IO.Compression/DeflateStream.xml @@ -362,11 +362,14 @@ You use this constructor when you want to specify whether compression efficiency - To be added. - To be added. - To be added. - To be added. + The stream to which compressed data is written. + The options for fine tuning the compression stream. + + to leave the stream object open after disposing the object; otherwise, + Initializes a new instance of the class by using the specified stream, compression options, and optionally leaves the stream open. To be added. + + or is . diff --git a/xml/System.IO.Compression/GZipStream.xml b/xml/System.IO.Compression/GZipStream.xml index 65612798e8f..cf953f70817 100644 --- a/xml/System.IO.Compression/GZipStream.xml +++ b/xml/System.IO.Compression/GZipStream.xml @@ -387,11 +387,14 @@ By default, the compression level is set to - To be added. - To be added. - To be added. - To be added. + The stream to which compressed data is written. + The options for fine tuning the compression stream. + + to leave the stream object open after disposing the object; otherwise, . + Initializes a new instance of the class by using the specified stream, compression options, and optionally leaves the stream open. To be added. + + or is . diff --git a/xml/System.IO.Compression/ZLibCompressionOptions.xml b/xml/System.IO.Compression/ZLibCompressionOptions.xml index 0dad67791c9..8f3ada755e6 100644 --- a/xml/System.IO.Compression/ZLibCompressionOptions.xml +++ b/xml/System.IO.Compression/ZLibCompressionOptions.xml @@ -14,7 +14,7 @@ - To be added. + Provides compression options to be used with , , and . To be added. @@ -51,9 +51,13 @@ System.Int32 - To be added. - To be added. - To be added. + Gets or sets the compression level for a compression stream. + The compression level for a compression stream. The default value is -1. + + Can accept any value between -1 and 9 (inclusive). 0 gives no compression, 1 gives best speed, 9 gives best compression, + and -1 requests the default compression level, which is equivalent to 6. + + The value is less than -1 or greater than 9. @@ -72,9 +76,10 @@ System.IO.Compression.ZLibCompressionStrategy - To be added. + Gets or sets the compression algorithm for a compression stream. To be added. To be added. + The value is not a valid value. diff --git a/xml/System.IO.Compression/ZLibCompressionStrategy.xml b/xml/System.IO.Compression/ZLibCompressionStrategy.xml index 5bff34de5c3..d4bfd840a43 100644 --- a/xml/System.IO.Compression/ZLibCompressionStrategy.xml +++ b/xml/System.IO.Compression/ZLibCompressionStrategy.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Defines the compression algorithms that can be used for , , and . To be added. @@ -34,7 +34,7 @@ 0 - To be added. + Used for normal data. @@ -54,7 +54,9 @@ 1 - To be added. + + Used for data produced by a filter (or predictor). The effect of Filtered is to force more Huffman coding and less string matching; it's an intermediate between Default and HuffmanOnly. + @@ -74,7 +76,7 @@ 4 - To be added. + Prevents the use of dynamic Huffman codes, allowing for a simpler decoder for special applications. @@ -94,7 +96,7 @@ 2 - To be added. + Used to force Huffman encoding only (no string match). @@ -114,7 +116,7 @@ 3 - To be added. + Used to limit match distances to one (run-length encoding). Gives better compression for PNG image data. diff --git a/xml/System.IO.Compression/ZLibStream.xml b/xml/System.IO.Compression/ZLibStream.xml index d198e01e82a..3a8215c0c57 100644 --- a/xml/System.IO.Compression/ZLibStream.xml +++ b/xml/System.IO.Compression/ZLibStream.xml @@ -158,11 +158,14 @@ - To be added. - To be added. - To be added. - To be added. + The stream to which compressed data is written. + The ZLib options for fine tuning the compression stream. + + to leave the stream object open after disposing the object; otherwise, . + Initializes a new instance of the class by using the specified stream and compression options, and optionally leaves the stream open. To be added. + + or is .