From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 29 May 2018 01:49:42 +0000 (-0700)
Subject: bpo-32878: Adds documentation for st_ino on Windows (GH-5764) (#7189)
X-Git-Tag: v3.7.0b5~19
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=78e14f8eb4b4a96d0766f2857c00de21d3303b17;p=python

bpo-32878: Adds documentation for st_ino on Windows (GH-5764) (#7189)

(cherry picked from commit 3e51a3d5927c680d5410ff11ff8d5e5bb9ffb1e7)

Co-authored-by: Steve Dower <steve.dower@microsoft.com>
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 784acf0ac5..60ab94f476 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -2378,7 +2378,13 @@ features:
 
    .. attribute:: st_ino
 
-      Inode number.
+      Platform dependent, but if non-zero, uniquely identifies the
+      file for a given value of ``st_dev``. Typically:
+
+      * the inode number on Unix,
+      * the `file index
+        <https://msdn.microsoft.com/en-us/library/aa363788>`_ on
+        Windows
 
    .. attribute:: st_dev
 
@@ -2537,6 +2543,10 @@ features:
    .. versionadded:: 3.5
       Added the :attr:`st_file_attributes` member on Windows.
 
+   .. versionchanged:: 3.5
+      Windows now returns the file index as :attr:`st_ino` when
+      available.
+
    .. versionadded:: 3.7
       Added the :attr:`st_fstype` member to Solaris/derivatives.