har0ke/FFmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/fate: better formatting

Browse Source 
The initial spaces get ignored anyway so let's be consistent with other docs.

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
Timothy Gu 2015-03-22 20:47:16 -07:00 committed by Michael Niedermayer
parent 83020f8978
commit 641ef7d4f7
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
doc/fate.texi
View File

@ -13,36 +13,36 @@
@chapter Introduction @chapter Introduction
FATE is an extended regression suite on the client-side and a means FATE is an extended regression suite on the client-side and a means
for results aggregation and presentation on the server-side. for results aggregation and presentation on the server-side.
The first part of this document explains how you can use FATE from The first part of this document explains how you can use FATE from
your FFmpeg source directory to test your ffmpeg binary. The second your FFmpeg source directory to test your ffmpeg binary. The second
part describes how you can run FATE to submit the results to FFmpeg's part describes how you can run FATE to submit the results to FFmpeg's
FATE server. FATE server.
In any way you can have a look at the publicly viewable FATE results In any way you can have a look at the publicly viewable FATE results
by visiting this website: by visiting this website:
@url{http://fate.ffmpeg.org/} @url{http://fate.ffmpeg.org/}
This is especially recommended for all people contributing source This is especially recommended for all people contributing source
code to FFmpeg, as it can be seen if some test on some platform broke code to FFmpeg, as it can be seen if some test on some platform broke
with their recent contribution. This usually happens on the platforms with their recent contribution. This usually happens on the platforms
the developers could not test on. the developers could not test on.
The second part of this document describes how you can run FATE to The second part of this document describes how you can run FATE to
submit your results to FFmpeg's FATE server. If you want to submit your submit your results to FFmpeg's FATE server. If you want to submit your
results be sure to check that your combination of CPU, OS and compiler results be sure to check that your combination of CPU, OS and compiler
is not already listed on the above mentioned website. is not already listed on the above mentioned website.
In the third part you can find a comprehensive listing of FATE makefile In the third part you can find a comprehensive listing of FATE makefile
targets and variables. targets and variables.
@chapter Using FATE from your FFmpeg source directory @chapter Using FATE from your FFmpeg source directory
If you want to run FATE on your machine you need to have the samples If you want to run FATE on your machine you need to have the samples
in place. You can get the samples via the build target fate-rsync. in place. You can get the samples via the build target fate-rsync.
Use this command from the top-level source directory: Use this command from the top-level source directory:
@ -51,11 +51,11 @@ make fate-rsync SAMPLES=fate-suite/
make fate SAMPLES=fate-suite/ make fate SAMPLES=fate-suite/
@end example @end example
The above commands set the samples location by passing a makefile The above commands set the samples location by passing a makefile
variable via command line. It is also possible to set the samples variable via command line. It is also possible to set the samples
location at source configuration time by invoking configure with location at source configuration time by invoking configure with
`--samples=<path to the samples directory>'. Afterwards you can @option{--samples=<path to the samples directory>}. Afterwards you can
invoke the makefile targets without setting the SAMPLES makefile invoke the makefile targets without setting the @var{SAMPLES} makefile
variable. This is illustrated by the following commands: variable. This is illustrated by the following commands:
@example @example
@ -64,7 +64,7 @@ make fate-rsync
make fate make fate
@end example @end example
Yet another way to tell FATE about the location of the sample Yet another way to tell FATE about the location of the sample
directory is by making sure the environment variable FATE_SAMPLES directory is by making sure the environment variable FATE_SAMPLES
contains the path to your samples directory. This can be achieved contains the path to your samples directory. This can be achieved
by e.g. putting that variable in your shell profile or by setting by e.g. putting that variable in your shell profile or by setting
@ -85,7 +85,7 @@ To use a custom wrapper to run the test, pass @option{--target-exec} to
@chapter Submitting the results to the FFmpeg result aggregation server @chapter Submitting the results to the FFmpeg result aggregation server
To submit your results to the server you should run fate through the To submit your results to the server you should run fate through the
shell script @file{tests/fate.sh} from the FFmpeg sources. This script needs shell script @file{tests/fate.sh} from the FFmpeg sources. This script needs
to be invoked with a configuration file as its first argument. to be invoked with a configuration file as its first argument.
@ -93,23 +93,23 @@ to be invoked with a configuration file as its first argument.
tests/fate.sh /path/to/fate_config tests/fate.sh /path/to/fate_config
@end example @end example
A configuration file template with comments describing the individual A configuration file template with comments describing the individual
configuration variables can be found at @file{doc/fate_config.sh.template}. configuration variables can be found at @file{doc/fate_config.sh.template}.
@ifhtml @ifhtml
The mentioned configuration template is also available here: The mentioned configuration template is also available here:
@verbatiminclude fate_config.sh.template @verbatiminclude fate_config.sh.template
@end ifhtml @end ifhtml
Create a configuration that suits your needs, based on the configuration Create a configuration that suits your needs, based on the configuration
template. The `slot' configuration variable can be any string that is not template. The @env{slot} configuration variable can be any string that is not
yet used, but it is suggested that you name it adhering to the following yet used, but it is suggested that you name it adhering to the following
pattern <arch>-<os>-<compiler>-<compiler version>. The configuration file pattern @samp{@var{arch}-@var{os}-@var{compiler}-@var{compiler version}}. The
itself will be sourced in a shell script, therefore all shell features may configuration file itself will be sourced in a shell script, therefore all
be used. This enables you to setup the environment as you need it for your shell features may be used. This enables you to setup the environment as you
build. need it for your build.
For your first test runs the `fate_recv' variable should be empty or For your first test runs the @env{fate_recv} variable should be empty or
commented out. This will run everything as normal except that it will omit commented out. This will run everything as normal except that it will omit
the submission of the results to the server. The following files should be the submission of the results to the server. The following files should be
present in $workdir as specified in the configuration file: present in $workdir as specified in the configuration file:
@ -122,29 +122,29 @@ present in $workdir as specified in the configuration file:
@item version @item version
@end itemize @end itemize
When you have everything working properly you can create an SSH key pair When you have everything working properly you can create an SSH key pair
and send the public key to the FATE server administrator who can be contacted and send the public key to the FATE server administrator who can be contacted
at the email address @email{fate-admin@@ffmpeg.org}. at the email address @email{fate-admin@@ffmpeg.org}.
Configure your SSH client to use public key authentication with that key Configure your SSH client to use public key authentication with that key
when connecting to the FATE server. Also do not forget to check the identity when connecting to the FATE server. Also do not forget to check the identity
of the server and to accept its host key. This can usually be achieved by of the server and to accept its host key. This can usually be achieved by
running your SSH client manually and killing it after you accepted the key. running your SSH client manually and killing it after you accepted the key.
The FATE server's fingerprint is: The FATE server's fingerprint is:
@table @option @table @samp
@item RSA @item RSA
d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51 d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51
@item ECDSA @item ECDSA
76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86 76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86
@end table @end table
If you have problems connecting to the FATE server, it may help to try out If you have problems connecting to the FATE server, it may help to try out
the @command{ssh} command with one or more @option{-v} options. You should the @command{ssh} command with one or more @option{-v} options. You should
get detailed output concerning your SSH configuration and the authentication get detailed output concerning your SSH configuration and the authentication
process. process.
The only thing left is to automate the execution of the fate.sh script and The only thing left is to automate the execution of the fate.sh script and
the synchronisation of the samples directory. the synchronisation of the samples directory.
@ -165,7 +165,7 @@ Run the FATE test suite (requires the fate-suite dataset).
@section Makefile variables @section Makefile variables
@table @option @table @env
@item V @item V
Verbosity level, can be set to 0, 1 or 2. Verbosity level, can be set to 0, 1 or 2.
@itemize @itemize
@ -183,20 +183,20 @@ Specify how many threads to use while running regression tests, it is
quite useful to detect thread-related regressions. quite useful to detect thread-related regressions.
@item THREAD_TYPE @item THREAD_TYPE
Specify which threading strategy test, either @var{slice} or @var{frame}, Specify which threading strategy test, either @samp{slice} or @samp{frame},
by default @var{slice+frame} by default @samp{slice+frame}
@item CPUFLAGS @item CPUFLAGS
Specify CPU flags. Specify CPU flags.
@item TARGET_EXEC @item TARGET_EXEC
Specify or override the wrapper used to run the tests. Specify or override the wrapper used to run the tests.
The @var{TARGET_EXEC} option provides a way to run FATE wrapped in 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 @command{valgrind}, @command{qemu-user} or @command{wine} or on remote targets
through @command{ssh}. through @command{ssh}.
@item GEN @item GEN
Set to @var{1} to generate the missing or mismatched references. Set to @samp{1} to generate the missing or mismatched references.
@end table @end table
@section Examples @section Examples