man: Add manpage for intel_error_decode
authorChris Wilson <chris@chris-wilson.co.uk>
Thu, 25 Feb 2010 18:52:15 +0000 (18:52 +0000)
committerChris Wilson <chris@chris-wilson.co.uk>
Thu, 25 Feb 2010 18:54:13 +0000 (18:54 +0000)
A rudimentary manpage based on intel_gpu_dump for the simple tool
for the post-processing of i915_error_state, intel_error_decode.

man/Makefile.am
man/intel_error_decode.1 [new file with mode: 0644]

index 304c480..9ab19f6 100644 (file)
@@ -2,6 +2,7 @@ dist_man1_MANS = \
        intel_audio_dump.1 \
        intel_bios_dumper.1 \
        intel_bios_reader.1 \
+       intel_error_decode.1 \
        intel_gpu_dump.1 \
        intel_gpu_top.1 \
        intel_gtt.1 \
diff --git a/man/intel_error_decode.1 b/man/intel_error_decode.1
new file mode 100644 (file)
index 0000000..db03bb6
--- /dev/null
@@ -0,0 +1,20 @@
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH intel_error_decode 1 "intel_error_decode 1.0"
+.SH NAME
+intel_error_decode \- Decodes an Intel GPU dump automatically captured by the kernel at the time of an error.
+.SH SYNOPSIS
+.nf
+.B intel_error_decode
+.B intel_error_decode [ filename ]
+.fi
+.SH DESCRIPTION
+.B intel_error_decode
+is a tool that decodes the instructions and state of the GPU at the time of
+an error. It requires kernel 2.6.34 or newer, and either debugfs mounted on
+/sys/kernel/debug or /debug containing a current i915_error_state or you can
+pass a file containing a saved error.
+.SS Options
+.TP
+.B filename
+Decodes a previously saved error.