doc: Updated release notes for features and major changes

Release notes were made consistent across CLI invocations.

Release notes were spell checked.

Added better notes for statedump support provided by Niels.

Edited some lines for consistent md formatting.

Change-Id: I459b3252a34bf6cbcf11fb44c7e4ed002bbe1530
BUG: 1417735
Signed-off-by: Shyam <srangana@redhat.com>
Reviewed-on: https://review.gluster.org/16700
CentOS-regression: Gluster Build System <jenkins@build.gluster.org>
NetBSD-regression: NetBSD Build System <jenkins@build.gluster.org>
Smoke: Gluster Build System <jenkins@build.gluster.org>

1 files changed, 34 insertions, 11 deletions

diff --git a/doc/release-notes/3.10.0.md b/doc/release-notes/3.10.0.md
index 7d6fc4fce05..4a410bee317 100644
--- a/doc/release-notes/3.10.0.md
+++ b/doc/release-notes/3.10.0.md
@@ -33,7 +33,6 @@ is USS and SSL.  Anyone using that combination should leave multiplexing off.
 
 ### Support to display op-version information from clients
 *Notes for users:*
-
 To get information on what op-version are supported by the clients, users can
 invoke the `gluster volume status` command for clients. Along with information
 on hostname, port, bytes read, bytes written and number of clients connected
@@ -50,7 +49,6 @@ operate. Following is the example usage:
 
 ### Support to get maximum op-version in a heterogeneous cluster
 *Notes for users:*
-
 A heterogeneous cluster operates on a common op-version that can be supported
 across all the nodes in the trusted storage pool. Upon upgrade of the nodes in
 the cluster, the cluster might support a higher op-version. Users can retrieve
@@ -75,7 +73,7 @@ The estimated time left for rebalance to complete is displayed
 as part of the rebalance status. Use the command:
 
 ```bash
-# gluster volume rebalance VOLNAME status
+# gluster volume rebalance <VOLNAME> status
 ```
 
 *Limitations:*
@@ -84,14 +82,13 @@ at while files are processed on the node and the total number of files
 on the brick which is determined using statfs. The limitations of this
 are:
 
- * A single fs partitiion must host only one brick. Multiple bricks on
+ * A single fs partition must host only one brick. Multiple bricks on
 the same fs partition will cause the statfs results to be invalid.
 
  * The estimates are dynamic and are recalculated every time the rebalance status
 command is invoked.The estimates become more accurate over time so short running
 rebalance operations may not benefit.
 
-
 *Known Issues:*
 As glusterfs does not stored the number of files on the brick, we use statfs to
 guess the number. The .glusterfs directory contents can significantly skew this
@@ -100,7 +97,7 @@ number and affect the calculated estimates.
 
 ### Separation of tier as its own service
 *Notes for users:*
-This change is to move the management of the tier deamon into the gluster
+This change is to move the management of the tier daemon into the gluster
 service framework, thereby improving it stability and manageability by the
 service framework.
 
@@ -114,16 +111,42 @@ operations.
 ### Statedump support for gfapi based applications
 *Notes for users:*
 gfapi based applications now can dump state information for better trouble
-shooting of issues.
+shooting of issues. A statedump can be triggered in two ways:
+
+1. by executing the following on one of the Gluster servers,
+   ```bash
+   # gluster volume statedump <VOLNAME> client <HOST>:<PID>
+   ```
+
+   - `<VOLNAME>` should be replaced by the name of the volume
+   - `<HOST>` should be replaced by the hostname of the system running the
+     gfapi application
+   - `<PID>` should be replaced by the PID of the gfapi application
+
+2. through calling `glfs_sysrq(<FS>, GLFS_SYSRQ_STATEDUMP)` within the
+   application
+
+   - `<FS>` should be replaced by a pointer to a `glfs_t` structure
+
+All statedumps (`*.dump.*` files) will be located at the usual location,
+on most distributions this would be `/var/run/gluster/`.
 
 *Limitations:*
+It is not possible to trigger statedumps from the Gluster CLI when the
+gfapi application has lost its management connection to the GlusterD
+servers.
+
+GlusterFS 3.10 is the first release that contains support for the new
+`glfs_sysrq()` function. Applications that include features for
+debugging will need to be adapted to call this function. At the time of
+the release of 3.10, no applications are known to call `glfs_sysrq()`.
 
 *Known Issues:*
 
 ### Disabled creation of trash directory by default
 *Notes for users:*
 From now onwards trash directory, namely .trashcan, will not be be created by
-default upon creation of new volumes unless and until the feature is tunred ON
+default upon creation of new volumes unless and until the feature is turned ON
 and the restrictions on the same will be applicable as long as features.trash
 is set for a particular volume.
 
@@ -175,7 +198,7 @@ The end benefit is faster create operations where IMA is not enabled.
 
 To cache this xattr use,
 ```bash
-# gluster volume set <volname> performance.cache-ima-xattrs on
+# gluster volume set <VOLNAME> performance.cache-ima-xattrs on
 ```
 
 The above option is on by default.
@@ -198,7 +221,7 @@ You can control which extensions to use or disable them with the following
 command:
 
 ```bash
-# gluster volume set <volname> disperse.cpu-extensions <type>
+# gluster volume set <VOLNAME> disperse.cpu-extensions <type>
 ```
 
 Valid <type> values are:
@@ -210,7 +233,7 @@ Valid <type> values are:
 * avx:  Use dynamic code generation using AVX extensions (256 bits)
 
 The default value is 'auto'. If a value is specified that is not detected on
-run-time, it will automatically fallback to the next available option.
+run-time, it will automatically fall back to the next available option.
 
 *Limitations:*