Merge commit '963b3ab11f98fcc4a311f0dc7b268890c5675da2'
authorClément Bœsch <u@pkh.me>
Sun, 19 Mar 2017 17:34:48 +0000 (18:34 +0100)
committerClément Bœsch <u@pkh.me>
Sun, 19 Mar 2017 17:34:48 +0000 (18:34 +0100)
* commit '963b3ab11f98fcc4a311f0dc7b268890c5675da2':
  doc: Document FATE option HWACCEL

Merged-by: Clément Bœsch <u@pkh.me>
1  2 
doc/fate.texi

diff --cc doc/fate.texi
@@@ -191,16 -96,78 +191,21 @@@ Specify CPU flags
  
  @item TARGET_EXEC
  Specify or override the wrapper used to run the tests.
 +The @env{TARGET_EXEC} option provides a way to run FATE wrapped in
 +@command{valgrind}, @command{qemu-user} or @command{wine} or on remote targets
 +through @command{ssh}.
  
  @item GEN
 -Set to @var{1} to generate the missing or mismatched references.
 +Set to @samp{1} to generate the missing or mismatched references.
+ @item HWACCEL
+ Specify which hardware acceleration to use while running regression tests,
 -by default none is used.
++by default @samp{none} is used.
  @end table
  
 -@example
 -    make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
 -@end example
 -
 -@chapter Automated Tests
 -In order to automatically testing specific configurations, e.g. multiple
 -compilers, @command{tests/fate.sh} is provided.
 -
 -This shell script builds Libav, runs the regression tests and prepares
 -a report that can be sent to @url{http://fate.libav.org/} or directly
 -examined locally.
 -
 -@section Testing Profiles
 -The configuration file passed to @command{fate.sh} is shell scripts as well.
 -
 -It must provide at least a @var{slot} identifier, the @var{repo} from
 -which fetch the sources, the @var{samples} directory, a @var{workdir} with
 -enough space to build and run all the tests.
 -Optional submit command @var{fate_recv} and a @var{comment} to describe
 -the testing profile are available.
 -
 -Additional optional parameter to tune the Libav building and reporting process
 -can be passed.
 +@section Examples
  
  @example
 -slot=                                   # some unique identifier
 -repo=git://git.libav.org/libav.git      # the source repository
 -#branch=release/10                      # the branch to test
 -samples=/path/to/fate/samples
 -workdir=                                # directory in which to do all the work
 -fate_recv="ssh -T fate@@fate.libav.org"  # command to submit report
 -comment=                                # optional description
 -build_only=     # set to "yes" for a compile-only instance that skips tests
 -
 -# the following are optional and map to configure options
 -arch=
 -cpu=
 -cross_prefix=
 -as=
 -cc=
 -ld=
 -target_os=
 -sysroot=
 -target_exec=
 -target_path=
 -target_samples=
 -extra_cflags=
 -extra_ldflags=
 -extra_libs=
 -extra_conf=     # extra configure options not covered above
 -
 -#make=          # name of GNU make if not 'make'
 -makeopts=       # extra options passed to 'make'
 -#tar=           # command to create a tar archive from its arguments on
 -                # stdout, defaults to 'tar c'
 +make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
  @end example
 -
 -@section Special Instances
 -The @var{TARGET_EXEC} option provides a way to run FATE wrapped in
 -@command{valgrind}, @command{qemu-user} or @command{wine} or on remote targets
 -through @command{ssh}.
 -
 -@section Submitting Reports
 -In order to send reports you need to create an @command{ssh} key and send it
 -to @email{root@@libav.org}.