1 files changed, 50 insertions, 0 deletions
diff --git a/lib/ansible/plugins/doc_fragments/result_format_callback.py b/lib/ansible/plugins/doc_fragments/result_format_callback.py
new file mode 100644
index 0000000..1b71173
--- /dev/null
+++ b/lib/ansible/plugins/doc_fragments/result_format_callback.py
@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2017, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    DOCUMENTATION = r'''
+    options:
+      result_format:
+        name: Format of the task result
+        description:
+          - Define the task result format used in the callback output.
+          - These formats do not cause the callback to emit valid JSON or YAML formats.
+          - The output contains these formats interspersed with other non-machine parsable data.
+        type: str
+        default: json
+        env:
+          - name: ANSIBLE_CALLBACK_RESULT_FORMAT
+        ini:
+          - key: callback_result_format
+            section: defaults
+        choices:
+            - json
+            - yaml
+        version_added: '2.13'
+      pretty_results:
+        name: Configure output for readability
+        description:
+          - Configure the result format to be more readable
+          - When the result format is set to C(yaml) this option defaults to C(True), and defaults
+            to C(False) when configured to C(json).
+          - Setting this option to C(True) will force C(json) and C(yaml) results to always be pretty
+            printed regardless of verbosity.
+          - When set to C(True) and used with the C(yaml) result format, this option will
+            modify module responses in an attempt to produce a more human friendly output at the expense
+            of correctness, and should not be relied upon to aid in writing variable manipulations
+            or conditionals. For correctness, set this option to C(False) or set the result format to C(json).
+        type: bool
+        default: null
+        env:
+          - name: ANSIBLE_CALLBACK_FORMAT_PRETTY
+        ini:
+          - key: callback_format_pretty
+            section: defaults
+        version_added: '2.13'
+'''