LUDOC-297 protocol: Update protocol document

[doc/protocol.git] / struct_obd_statfs.txt

diff --git a/struct_obd_statfs.txt b/struct_obd_statfs.txt
index 0491cf2..13f9945 100644 (file)
--- a/struct_obd_statfs.txt
+++ b/struct_obd_statfs.txt
@@ -1,9 +1,8 @@
-OBD Statfs
-^^^^^^^^^^
+.OBD Statfs
 [[struct-obd-statfs]]
-
-An 'obd_statfs' structure conveys file-system-wide information for the
-back-end file system of a given target (MDT or OST).
+****
+An 'obd_statfs' structure conveys file-system-wide information of a
+given target (MDT or OST).
 
 [source,c]
 ----
@@ -30,16 +29,16 @@ struct obd_statfs {
         __u32  os_spare9;
 };
 ----
+****
 
 Most of the fields correspond directly to the 'struct statfs' fields
 returned by a 'statfs()' system call and have the same meaning. The
-values are for the back-end storage of the target in question (MDT or
-OST).
+values are for the target in question (MDT or OST).
 
-Teh 'os_type' field gives the type of the target's back-end file
-system:
+The 'os_type' field gives the kind of file system used for the
+target's OSD:
 
-.Back-end file types ('os_type') for Lustre targets
+.File system types ('os_type') for Lustre targets
 [options="header"]
 |====
 | f_type                     | value
@@ -76,18 +75,17 @@ the total, free, and available space in combination with 'os_blocks',
 'os_bfree', and 'os_bavail' respectively.  It does not necessarily
 represent the minimum or optimal IO size.
 
-The 'os_namelen' field gives the maximum name length for files on the
-back-end file system in bytes.
+The 'os_namelen' field gives the maximum name length (in bytes) for
+files on the OSD.
 
 The 'os_maxbytes' field is the maximum size of a single object
 (i.e. the maximum byte offset that can be written to).  This is the
 same value as the 'ocd_maxbytes' field of the 'obd_connect_data'
 structure.
 
-The 'os_state' field encodes the status of the underlying back-end
-file system. It can be:
+The 'os_state' field encodes the status of the OSD. It can be:
 
-.Back-end file system state
+.OSD state
 [options="header"]
 |====
 | os_state flag     | value
@@ -96,7 +94,7 @@ file system. It can be:
 |====
 
 In normal operation the 'os_state' value is returned as 0x0.  If the
-back-end file system has a RAID configuration that is degraded or
+OSD has a RAID configuration that is degraded or
 rebuilding the state is returned with the OS_STATE_DEGRADED (0x1) flag
 set. If the file system has been set to read-only, either manually at
 mount or automatcially due to detected corruption of the underlying
@@ -110,3 +108,4 @@ inodes, so it reduces 'os_ffree'. Lustre places a hard limit of
 2*OST_MAX_PRECREATE (2*20000) on the number of precreates it will
 allow for an OST. There are currently no precreated objects on an MDT
 so it is just 0 in that case.
+