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

28
doc/fate.texi
View File

@ -54,8 +54,8 @@ make fate SAMPLES=fate-suite/
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
@ -102,14 +102,14 @@ configuration variables can be found at @file{doc/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:
@ -132,7 +132,7 @@ 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
@ -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