From 90949ee29168a19acd45b6ee7ede61d06d429a69 Mon Sep 17 00:00:00 2001
From: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Date: Fri, 3 Oct 2025 11:40:54 -0700
Subject: [PATCH] random param fixes
---
xml/System.IO.Log/LogExtentCollection.xml | 6 +-
xml/System.IO.Log/LogStore.xml | 408 ++++++++++----------
xml/System.IO.Log/ReservationCollection.xml | 4 -
xml/System.IO/DirectoryInfo.xml | 1 -
4 files changed, 205 insertions(+), 214 deletions(-)
diff --git a/xml/System.IO.Log/LogExtentCollection.xml b/xml/System.IO.Log/LogExtentCollection.xml
index 2a3d7bc100f..4662555f5ac 100644
--- a/xml/System.IO.Log/LogExtentCollection.xml
+++ b/xml/System.IO.Log/LogExtentCollection.xml
@@ -150,11 +150,7 @@
or is .
-
- is not within a valid range.
- The log store file name specified by is not valid.
-
- is smaller than the size of the other extents in the store.
+ The log store file name specified by is not valid, or is smaller than the size of the other extents in the store.
A size must be specified for the first extent.
-or-
diff --git a/xml/System.IO.Log/LogStore.xml b/xml/System.IO.Log/LogStore.xml
index 729b5e372df..0fab8210ddf 100644
--- a/xml/System.IO.Log/LogStore.xml
+++ b/xml/System.IO.Log/LogStore.xml
@@ -21,25 +21,25 @@
Represents a log-structured storage.
- class provides an implementation of the record sequence interface on top of a Common Log File System (CLFS) log. It works with the class, which provides an interface for directly manipulating and managing a CLFS log file. A log store provides append-only storage across a set of disk extents. The class represents this storage, and provides methods for adding and removing containers, setting policy, and creating archives. It does not provide methods for reading from and writing to the storage; these methods are provided by the class.
-
- The relationship between the class and the class is similar to the relationship between a disk file and a object. The disk file provides the actual storage and has attributes such as length and last access time, while the object provides a view on the file that can be used to read from it and write to it. Similarly, the class has attributes like a policy and a collection of disk extents, and the class provides a record-oriented mechanism for reading and writing data.
-
- Unlike the file record sequence represented by the class, a instance stores its data in a collection of disk extents, represented by instances. The extents in a given instance are all of uniform size, and space is added to and removed from a instance in extent increments. To add and remove log extents, use the and methods of the object, which can be returned by the property.
-
- A instance can have policies associated with it. These are represented by instances that can be returned by the property. A policy dictates rules that the log will attempt to follow, such as maximum number of extents and minimum size, and instructions on growing or shrinking the under certain conditions. In addition, you can specify whether a instance can be archived. Policies are set per log and are volatile, which means that once every handle to the log is closed, the policy no longer exists.
-
-
-
-## Examples
- The following example shows how to archive a to an XML document.
-
+ class provides an implementation of the record sequence interface on top of a Common Log File System (CLFS) log. It works with the class, which provides an interface for directly manipulating and managing a CLFS log file. A log store provides append-only storage across a set of disk extents. The class represents this storage, and provides methods for adding and removing containers, setting policy, and creating archives. It does not provide methods for reading from and writing to the storage; these methods are provided by the class.
+
+ The relationship between the class and the class is similar to the relationship between a disk file and a object. The disk file provides the actual storage and has attributes such as length and last access time, while the object provides a view on the file that can be used to read from it and write to it. Similarly, the class has attributes like a policy and a collection of disk extents, and the class provides a record-oriented mechanism for reading and writing data.
+
+ Unlike the file record sequence represented by the class, a instance stores its data in a collection of disk extents, represented by instances. The extents in a given instance are all of uniform size, and space is added to and removed from a instance in extent increments. To add and remove log extents, use the and methods of the object, which can be returned by the property.
+
+ A instance can have policies associated with it. These are represented by instances that can be returned by the property. A policy dictates rules that the log will attempt to follow, such as maximum number of extents and minimum size, and instructions on growing or shrinking the under certain conditions. In addition, you can specify whether a instance can be archived. Policies are set per log and are volatile, which means that once every handle to the log is closed, the policy no longer exists.
+
+
+
+## Examples
+ The following example shows how to archive a to an XML document.
+
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/logarchievesnapshot/cs/logarchievesnapshot.cs" id="Snippet0":::
- :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
-
+ :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
+
]]>
@@ -103,32 +103,32 @@
One of the values that determines how to open or create the store.
Initializes a new instance of the class with the specified path and mode.
- [::]`
-
- where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
-
- Clients that share the same physical log name share the same extents collection and policy.
-
+ [::]`
+
+ where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
+
+ Clients that share the same physical log name share the same extents collection and policy.
+
]]>
is .
- is an empty string ("").
-
- -or-
-
- contains only white space.
-
- -or-
-
+ is an empty string ("").
+
+ -or-
+
+ contains only white space.
+
+ -or-
+
contains one or more invalid characters.
contains an invalid value.
@@ -164,38 +164,38 @@
One of the values that determines how the file can be accessed by the .
Initializes a new instance of the class with the specified path, mode, and access.
- [::]`
-
- where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
-
- Clients that share the same physical log name share the same extents collection and policy.
-
+ [::]`
+
+ where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
+
+ Clients that share the same physical log name share the same extents collection and policy.
+
]]>
is .
- is an empty string ("").
-
- -or-
-
- contains only white space.
-
- -or-
-
+ is an empty string ("").
+
+ -or-
+
+ contains only white space.
+
+ -or-
+
contains one or more invalid characters.
- contains an invalid value.
-
- -or
-
+ contains an invalid value.
+
+ -or
+
contains an invalid value.
The file cannot be found.
An I/O error occurs when opening the log store.
@@ -231,42 +231,42 @@
One of the values that determines how the log store will be shared among processes.
Initializes a new instance of the class.
- object that it opens with the specified path, mode, and access. The store is opened sharing the specified access.
-
- The `path` parameter should use the following syntax:
-
- `log:[::]`
-
- where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
-
- Clients that share the same physical log name share the same extents collection and policy.
-
+ object that it opens with the specified path, mode, and access. The store is opened sharing the specified access.
+
+ The `path` parameter should use the following syntax:
+
+ `log:[::]`
+
+ where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
+
+ Clients that share the same physical log name share the same extents collection and policy.
+
]]>
is .
- is an empty string ("").
-
- -or-
-
- contains only white space.
-
- -or-
-
+ is an empty string ("").
+
+ -or-
+
+ contains only white space.
+
+ -or-
+
contains one or more invalid characters.
- contains an invalid value.
-
- -or
-
- contains an invalid value.
-
- -or-
-
+ contains an invalid value.
+
+ -or
+
+ contains an invalid value.
+
+ -or-
+
contains an invalid value.
The file cannot be found.
An I/O error occurs when opening the log store.
@@ -304,55 +304,55 @@
One of the value that specifies the security to set on the newly created store if the store must be created.
Initializes a new instance of the class.
- object that it opens with the specified path, mode, and access. The store is opened sharing the specified access. The `path` parameter should follow the following syntax:
-
- `log:[::]`
-
- where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
-
- Clients that share the same physical log name share the same extents collection and policy.
-
+ object that it opens with the specified path, mode, and access. The store is opened sharing the specified access. The `path` parameter should follow the following syntax:
+
+ `log:[::]`
+
+ where `` is a valid path to a log file, and `` is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.
+
+ Clients that share the same physical log name share the same extents collection and policy.
+
]]>
is .
- The log store file name specified by is not valid.
-
- -or-
-
- is , which cannot be used without write access.
-
- -or-
-
- is , which cannot be used without write access.
+ The log store file name specified by is not valid.
+
+ -or-
+
+ is , which cannot be used without write access.
+
+ -or-
+
+ is , which cannot be used without write access.
- contains an invalid value.
-
- -or
-
- contains an invalid value.
-
- -or-
-
+ contains an invalid value.
+
+ -or
+
+ contains an invalid value.
+
+ -or-
+
contains an invalid value.
The file cannot be found.
- An I/O error occurs when opening the log store.
-
- The file specified by cannot be accessed because it is in use by another process.
-
- -or-
-
- The file specified by cannot be created because the file or directory already exists.
-
- -or-
-
- The log handle could not be bound to the thread pool.
-
- -or-
-
+ An I/O error occurs when opening the log store.
+
+ The file specified by cannot be accessed because it is in use by another process.
+
+ -or-
+
+ The file specified by cannot be created because the file or directory already exists.
+
+ -or-
+
+ The log handle could not be bound to the thread pool.
+
+ -or-
+
The specified log file format or version is invalid.
cannot be used because the required Common Log File System (CLFS) component is not installed. Install the CLFS component if it is available for your platform or use the class instead.
@@ -383,11 +383,11 @@
if this instance can be archived; otherwise, .
- is not archivable, calls to the and methods result in a being thrown.
-
+ is not archivable, calls to the and methods result in a being thrown.
+
]]>
The property was accessed after the sequence has been disposed of.
@@ -413,11 +413,11 @@
Gets the lowest sequence number that corresponds to a valid record in this instance.
The lowest sequence number that corresponds to a valid record in this instance.
- and less than .
-
+ and less than .
+
]]>
The property was accessed after the sequence has been disposed of.
@@ -453,14 +453,14 @@
Takes a snapshot of the log store state for making a backup.
A object that contains the state necessary to make an archive.
- to an XML document.
-
+ to an XML document.
+
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/logarchievesnapshot/cs/logarchievesnapshot.cs" id="Snippet0":::
- :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
-
+ :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
+
]]>
The log store is not archivable.
@@ -499,11 +499,11 @@
Takes a snapshot of the log store state between the specified sequence numbers for making a backup.
A object that contains the state necessary to make an archive.
-
@@ -545,14 +545,14 @@
is .
- is an empty string ("").
-
- -or-
-
- contains only white space.
-
- -or-
-
+ is an empty string ("").
+
+ -or-
+
+ contains only white space.
+
+ -or-
+
contains one or more invalid characters.
The file cannot be found.
An I/O error occurs when opening the log store.
@@ -582,14 +582,14 @@
Releases all resources used by the .
- when you have finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying.
-
+ when you have finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying.
+
> [!NOTE]
-> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method.
-
+> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method.
+
]]>
The method was called after the sequence has been disposed of.
@@ -615,11 +615,11 @@
Gets the collection of log extents that contain the data for this log store.
A instance containing the collection of log extents that encapsulates data for this log store.
- instance stores its data in a collection of disk extents, represented by instances. The extents in a given instance are all of uniform size, and space is added to and removed from a instance in extent increments. To add and remove log extents, use the and methods of the object, which is returned by this property.
-
+ instance stores its data in a collection of disk extents, represented by instances. The extents in a given instance are all of uniform size, and space is added to and removed from a instance in extent increments. To add and remove log extents, use the and methods of the object, which is returned by this property.
+
]]>
@@ -689,11 +689,11 @@
When overridden in a derived class, gets the sequence number of the next record to be appended to the log store.
The sequence number of the next record to be appended to the log store.
- and less than .
-
+ and less than .
+
]]>
The property was accessed after the sequence has been disposed of.
@@ -719,11 +719,11 @@
Gets the size of the log store, in bytes.
The size of the log store, in bytes.
-
The property was accessed after the sequence has been disposed of.
@@ -749,11 +749,11 @@
Gets the policy associated with this log store.
A instance representing the policy associated with this log store.
- instance returned by this property to examine and manipulate the log policy associated with this .
-
+ instance returned by this property to examine and manipulate the log policy associated with this .
+
]]>
@@ -781,19 +781,19 @@
The sequence number of the archive tail.
Sets the sequence number of the archive tail.
- to an XML document.
-
+ to an XML document.
+
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/logarchievesnapshot/cs/logarchievesnapshot.cs" id="Snippet0":::
- :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
-
+ :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/logarchievesnapshot/vb/logarchievesnapshot.vb" id="Snippet0":::
+
]]>
diff --git a/xml/System.IO.Log/ReservationCollection.xml b/xml/System.IO.Log/ReservationCollection.xml
index b64977979d7..fbb212fd9f6 100644
--- a/xml/System.IO.Log/ReservationCollection.xml
+++ b/xml/System.IO.Log/ReservationCollection.xml
@@ -158,8 +158,6 @@ recordSequence.Append(undoRecordData, userSqn, previousSqn, RecordAppendOptions.
]]>
-
- is not between the base and last sequence numbers of this sequence.
is invalid or exceeds maximum reservation size.
An I/O error occurs when creating the archive snapshot.
@@ -192,8 +190,6 @@ recordSequence.Append(undoRecordData, userSqn, previousSqn, RecordAppendOptions.
Releases all of the reservations in the collection. This method cannot be inherited.
To be added.
-
- is invalid or exceeds maximum reservation size.
An I/O error occurs when creating the archive snapshot.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
diff --git a/xml/System.IO/DirectoryInfo.xml b/xml/System.IO/DirectoryInfo.xml
index 8740a5066a1..a62e1c4b87e 100644
--- a/xml/System.IO/DirectoryInfo.xml
+++ b/xml/System.IO/DirectoryInfo.xml
@@ -354,7 +354,6 @@ namespace ConsoleApp
]]>
The caller does not have the required permission.
- .NET Framework and .NET Core versions older than 2.1: is a zero-length string, contains only white space, or contains one or more invalid characters. You can query for invalid characters by using the method.
The specified path, file name, or both exceed the system-defined maximum length.
The specified path is invalid, such as being on an unmapped drive.
Creating a directory with only the colon (:) character was attempted.