mirror of
https://github.com/tiagovignatti/intel-gpu-tools.git
synced 2025-06-24 00:06:09 +00:00
Update README
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
This commit is contained in:
parent
5d46f68eab
commit
84f23415c4
46
README
46
README
@ -1,17 +1,22 @@
|
||||
This is a collection of tools for development and testing of the Intel DRM
|
||||
driver. There are many macro-level test suites that get used against our
|
||||
driver, including xtest, rendercheck, piglit, and oglconform, but failures
|
||||
Intel GPU Tools
|
||||
===============
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Intel GPU Tools is a collection of tools for development and testing of the
|
||||
Intel DRM driver. There are many macro-level test suites that get used against
|
||||
the driver, including xtest, rendercheck, piglit, and oglconform, but failures
|
||||
from those can be difficult to track down to kernel changes, and many require
|
||||
complicated build procedures or specific testing environments to get useful
|
||||
results.
|
||||
results. Therefore, Intel GPU Tools includes low-level tools and tests
|
||||
specifically for development and testing of the Intel DRM Driver.
|
||||
|
||||
Thus, intel-graphics-tools was a project I started to collect some low-level
|
||||
tools I intended to build.
|
||||
Intel GPU Tools is split into several sections:
|
||||
|
||||
benchmarks/
|
||||
This should be a collection of useful microbenchmarks. The hope is
|
||||
that people can use these to tune some pieces of DRM code in relevant
|
||||
ways.
|
||||
This is a collection of useful microbenchmarks that can be used to tune
|
||||
DRM code in relevant ways.
|
||||
|
||||
The benchmarks require KMS to be enabled. When run with an X Server
|
||||
running, they must be run as root to avoid the authentication
|
||||
@ -21,8 +26,11 @@ benchmarks/
|
||||
|
||||
tests/
|
||||
This is a set of automated tests to run against the DRM to validate
|
||||
changes. Hopefully this can cover the relevant cases we need to
|
||||
worry about, including backwards compatibility.
|
||||
changes. Many of the tests have subtests, which can be listed by using
|
||||
the --list-subtests command line option and then run using the
|
||||
--run-subtest option. If --run-subtest is not used, all subtests will
|
||||
be run. Some tests have futher options and these are detailed by using
|
||||
the --help option.
|
||||
|
||||
The test suite can be run using the run-tests.sh script available in
|
||||
the scripts directory. Piglit is used to run the tests and can either
|
||||
@ -115,9 +123,10 @@ debugger/
|
||||
The debugger must be run as root: "sudo debugger/eudb"
|
||||
|
||||
docs/
|
||||
Thus far just contains the autogenerated intel-gpu-tools libraries
|
||||
reference documenation in docs/reference/ You need to have the gtk doc
|
||||
tools installed to generate this API documentation.
|
||||
Contains the automatically generated intel-gpu-tools libraries
|
||||
reference documentation in docs/reference/. You need to have the
|
||||
gtk-doc tools installed and use the "--enable-gtk-doc" configure flag
|
||||
to generate this API documentation.
|
||||
|
||||
To regenerate the html files when updating documentation, use:
|
||||
|
||||
@ -128,9 +137,12 @@ docs/
|
||||
intel-gpu-tools-sections.txt. Entirely new sections will also need to be
|
||||
added to intel-gpu-tools-docs.xml in the appropriate place.
|
||||
|
||||
DEPENDENCIES
|
||||
This is a non-exchaustive list of package dependencies required for
|
||||
building everything:
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
This is a non-exhaustive list of package dependencies required for
|
||||
building everything:
|
||||
|
||||
libpciaccess-dev
|
||||
libdrm-dev
|
||||
|
Loading…
x
Reference in New Issue
Block a user