doc: Add release notes for the output format changes

Signed-off-by: David Zafman <dzafman@redhat.com>

diff --git a/PendingReleaseNotes b/PendingReleaseNotes
index 5bba096c8f3176c36b3222f79d491a0b92426eb2..c9eaa94ed4564c20001003a352ac80055de806f3 100644 (file)
--- a/PendingReleaseNotes
+++ b/PendingReleaseNotes
@@ -126,3 +126,42 @@ method. See http://docs.ceph.com/docs/luminous/mgr/restful for details.
   your cluster then your configuration should be adjusted in order to
   avoid reverting to the default value.
 
+* *rados list-inconsistent-obj format changes:*
+
+  * Various error strings have been improved.  For example, the "oi" or "oi_attr"
+    in errors which stands for object info is now "info" (e.g. oi_attr_missing is
+    now info_missing).
+
+  * The object's "selected_object_info" is now in json format instead of string.
+
+  * The attribute errors (attr_value_mismatch, attr_name_mismatch) only apply to user
+    attributes.  Only user attributes are output and have the internal leading underscore
+    stripped.
+
+  * If there are hash information errors (hinfo_missing, hinfo_corrupted,
+    hinfo_inconsistency) then "hashinfo" is added with the json format of the
+    information.  If the information is corrupt then "hashinfo" is a string
+    containing the value.
+
+  * If there are snapset errors (snapset_missing, snapset_corrupted,
+    snapset_inconsistency) then "snapset" is added with the json format of the
+    information.  If the information is corrupt then "snapset" is a string containing
+    the value.
+
+  * If there are object information errors (info_missing, info_corrupted,
+    obj_size_info_mismatch, object_info_inconsistency) then "object_info" is added
+    with the json format of the information instead of a string.  If the information
+    is corrupt then "object_info" is a string containing the value.
+
+* *rados list-inconsistent-snapset format changes:*
+
+  * Various error strings have been improved.  For example, the "ss_attr" in
+    errors which stands for snapset info is now "snapset" (e.g. ss_attr_missing is
+    now snapset_missing).  The error snapset_mismatch has been renamed to snapset_error
+    to better reflect what it means.
+
+  * The head snapset information is output in json format as "snapset."  This means that
+    even when there are no head errors, the head object will be output when any shard
+    has an error.  This head object is there to show the snapset that was used in
+    determining errors.
+