summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTvrtko Ursulin <tvrtko.ursulin@intel.com>2021-03-31 10:12:41 +0100
committerTvrtko Ursulin <tvrtko.ursulin@intel.com>2021-04-01 16:39:23 +0100
commit84e6a7e19ccc7fafc46f372e756cad9d4aa093f7 (patch)
tree9720f58f977d6cbcef46bec0f88f2f3fadb2a678 /man
parent08f95a5eb7cccabf56f9873b54d3951914be2ab8 (diff)
intel_gpu_top: Document how to use JSON output
Put a note on how to use JSON output into the man page. Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com> References: https://gitlab.freedesktop.org/drm/igt-gpu-tools/-/issues/100 Acked-by: Matthew Auld <matthew.auld@intel.com>
Diffstat (limited to 'man')
-rw-r--r--man/intel_gpu_top.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
index f6d74852..f4dbfc5b 100644
--- a/man/intel_gpu_top.rst
+++ b/man/intel_gpu_top.rst
@@ -81,6 +81,11 @@ Filter types: ::
pci pci:[vendor=%04x/name][,device=%04x][,card=%d]
vendor is hex number or vendor name
+JSON OUTPUT
+===========
+
+To parse the JSON as output by the tool the consumer should wrap its entirety into square brackets ([ ]). This will make each sample point a JSON array element and will avoid "Multiple root elements" JSON validation error.
+
LIMITATIONS
===========