From c6f8e10070fa718d239a0868c0212e75f3f775f6 Mon Sep 17 00:00:00 2001
From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com>
Date: Wed, 8 Sep 2021 11:08:51 -0700
Subject: [PATCH 1/2] Update symlink documentation
---
xml/System.IO/Directory.xml | 29 +++++++++++++++++++++++------
xml/System.IO/File.xml | 26 ++++++++++++++++++++++----
xml/System.IO/FileSystemInfo.xml | 31 +++++++++++++++++++++++++------
3 files changed, 70 insertions(+), 16 deletions(-)
diff --git a/xml/System.IO/Directory.xml b/xml/System.IO/Directory.xml
index 3f6660e32f9..2306305aff4 100644
--- a/xml/System.IO/Directory.xml
+++ b/xml/System.IO/Directory.xml
@@ -365,7 +365,7 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");
- The absolute path where the symbolic link should be created.
+ The path where the symbolic link should be created.
The target directory of the symbolic link.
Creates a directory symbolic link identified by that points to .
A instance that wraps the newly created directory symbolic link.
@@ -374,10 +374,17 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");
or is .
or is empty.
- -or- is not an absolute path.
- -or- or contains invalid path characters.
+
+-or-
+
+ or contains invalid path characters.
A file or directory already exists in the location of .
- -or- An I/O error occurred.
+
+-or-
+
+An I/O error occurred.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -4092,11 +4099,21 @@ Directory::CreateDirectory("c:\\Users\\User1\\Public\\Html");
When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.
+Symbolic links and junctions are the types of links this API can resolve.
+
]]>
The directory on does not exist.
- -or- The link's file system entry type is inconsistent with that of its target.
- -or- Too many levels of symbolic links.
+
+-or-
+
+The link's file system entry type is inconsistent with that of its target.
+
+-or-
+
+Too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml
index 432f95c1508..4b199e68fc9 100644
--- a/xml/System.IO/File.xml
+++ b/xml/System.IO/File.xml
@@ -1391,9 +1391,17 @@
or is .
or is empty.
- -or- or contains a character.
+
+-or-
+
+ or contains a character.
A file or directory already exists in the location of .
- -or- An I/O error occurred.
+
+-or-
+
+An I/O error occurred.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -4716,11 +4724,21 @@ The following example moves a file.
When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.
+Symbolic links and junctions are the types of links this API can resolve.
+
]]>
The file on does not exist.
- -or- The link's file system entry type is inconsistent with that of its target.
- -or- Too many levels of symbolic links.
+
+-or-
+
+The link's file system entry type is inconsistent with that of its target.
+
+-or-
+
+Too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
diff --git a/xml/System.IO/FileSystemInfo.xml b/xml/System.IO/FileSystemInfo.xml
index 5c8927969f9..d1ec14c0f80 100644
--- a/xml/System.IO/FileSystemInfo.xml
+++ b/xml/System.IO/FileSystemInfo.xml
@@ -361,10 +361,17 @@
is .
is empty.
- -or- This instance was not created passing an absolute path.
- -or- contains invalid path characters.
+
+-or-
+
+ contains invalid path characters.
A file or directory already exists in the location of .
- -or- An I/O error occurred.
+
+-or-
+
+An I/O error occurred.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -1315,7 +1322,9 @@ The `Extension` property returns the extension,
If this instance represents a link, returns the link target's path.
If a link does not exist in , or this instance does not represent a link, returns .
To be added.
- To be added.
+ Symbolic links and junctions are the types of links this API can resolve.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -1530,11 +1539,21 @@ Call `Refresh` before attempting to get the attribute information, or the inform
When `returnFinalTarget` is `true`, the maximum number of symbolic links that are followed are 40 on Unix and 63 on Windows.
+Symbolic links and junctions are the types of links this API can resolve.
+
]]>
The file or directory does not exist.
- -or- The link's file system entry type is inconsistent with that of its target.
- -or- Too many levels of symbolic links.
+
+-or-
+
+The link's file system entry type is inconsistent with that of its target.
+
+-or-
+
+Too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
From 69aae2789b6008282edb93787417d4605b313dae Mon Sep 17 00:00:00 2001
From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
Date: Wed, 8 Sep 2021 13:06:29 -0700
Subject: [PATCH 2/2] Apply suggestions from code review
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
---
xml/System.IO/Directory.xml | 6 +++---
xml/System.IO/File.xml | 10 +++++-----
xml/System.IO/FileSystemInfo.xml | 14 +++++++-------
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/xml/System.IO/Directory.xml b/xml/System.IO/Directory.xml
index 2306305aff4..2c5e7666443 100644
--- a/xml/System.IO/Directory.xml
+++ b/xml/System.IO/Directory.xml
@@ -4111,9 +4111,9 @@ The link's file system entry type is inconsistent with that of its target.
-or-
-Too many levels of symbolic links.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+There are too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml
index 4b199e68fc9..4f86f4221c0 100644
--- a/xml/System.IO/File.xml
+++ b/xml/System.IO/File.xml
@@ -1400,8 +1400,8 @@
-or-
An I/O error occurred.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -4736,9 +4736,9 @@ The link's file system entry type is inconsistent with that of its target.
-or-
-Too many levels of symbolic links.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+There are too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
diff --git a/xml/System.IO/FileSystemInfo.xml b/xml/System.IO/FileSystemInfo.xml
index d1ec14c0f80..48e75bf98a8 100644
--- a/xml/System.IO/FileSystemInfo.xml
+++ b/xml/System.IO/FileSystemInfo.xml
@@ -370,8 +370,8 @@
-or-
An I/O error occurred.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -1323,8 +1323,8 @@ The `Extension` property returns the extension,
If a link does not exist in , or this instance does not represent a link, returns .
To be added.
Symbolic links and junctions are the types of links this API can resolve.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations
@@ -1551,9 +1551,9 @@ The link's file system entry type is inconsistent with that of its target.
-or-
-Too many levels of symbolic links.
- Windows Developer - Symbolic Links
- Windows Developer - Reparse Points and File Operations
+There are too many levels of symbolic links.
+ Windows Developer - Symbolic Links
+ Windows Developer - Reparse Points and File Operations