This file is indexed.

/usr/share/doc/libav/fate.html is in libav-tools 6:11.12-1~deb8u1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<!DOCTYPE html>
<html>
<!-- Created on February 18, 2018 by texi2html 1.82 -->
<!--
texi2html was written by: 
            Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>

-->
<head>
<title>Libav documentation : FATE Automated Testing Environment: </title>

<meta name="description" content="FATE Automated Testing Environment: ">
<meta name="keywords" content="Libav documentation : FATE Automated Testing Environment: ">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.82">

<style type="text/css">
<!--
.container {
  margin-right: auto;
  margin-left: auto;
  width: 1070px;
}
body {
  font-size: 14px;
  line-height: 20px;
  color: #333333;
  background-color: #ffffff;
}
a {
  color: #0088cc;
  text-decoration: none;
}
a:hover {
  color: #005580;
  text-decoration: underline;
}
p {
  margin: 0 0 10px;
}
h2,
h3,
h4 {
  margin: 10px 0;
  font-family: inherit;
  font-weight: bold;
  line-height: 1;
  border-color: #D6E9C6;
  color: #468847;
  border-style: solid;
  border-width: 0 0 1px;
  padding-left: 0.5em;
}

h1 a,
h2 a,
h3 a,
h4 a {
  color: inherit;
}
h1 {
  font-size: 30px;
  line-height: 40px;
}
h2 {
  font-size: 20px;
  line-height: 40px;
}
h3 {
  font-size: 18px;
  line-height: 40px;
}
code,
pre {
  padding: 0 3px 2px;
  font-family: monospace;
  font-size: 12px;
  color: #333333;
  border-radius: 3px;
}
pre {
  display: block;
  padding: 9.5px;
  margin: 0 0 10px;
  font-size: 13px;
  line-height: 20px;
  word-break: break-all;
  word-wrap: break-word;
  white-space: pre;
  white-space: pre-wrap;
  background-color: #f5f5f5;
  border: 1px solid #ccc;
  border-radius: 4px;
}

code {
  padding: 2px 4px;
  color: #d14;
  background-color: #f7f7f9;
  border: 1px solid #e1e1e8;
}
pre code {
  padding: 0;
  color: inherit;
  background-color: transparent;
  border: 0;
}
.alert {
  padding: 8px 35px 8px 14px;
  margin-bottom: 20px;
  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
  background-color: #fcf8e3;
  border: 1px solid #fbeed5;
  border-radius: 4px;
  color: #c09853;
}

.alert-danger,
.alert-error {
  background-color: #f2dede;
  border-color: #eed3d7;
  color: #b94a48;
}
.alert-info {
  background-color: #d9edf7;
  border-color: #bce8f1;
  color: #3a87ad;
}

ul.toc {
  list-style-type: none;
}
-->
</style>

<link rel="icon" href="favicon.png" type="image/png" />
</head>
<body>
<div class="container">

<a name="SEC_Top"></a>
<h1 class="settitle">FATE Automated Testing Environment</h1>

<a name="SEC_Contents"></a>
<h1>Table of Contents</h1>
<div class="contents">

<ul class="toc">
  <li><a name="toc-Introduction" href="#Introduction">1. Introduction</a></li>
  <li><a name="toc-Running-FATE" href="#Running-FATE">2. Running FATE</a>
  <ul class="toc">
    <li><a name="toc-Samples-and-References" href="#Samples-and-References">2.1 Samples and References</a></li>
  </ul></li>
  <li><a name="toc-Manual-Run" href="#Manual-Run">3. Manual Run</a>
  <ul class="toc">
    <li><a name="toc-FATE-Makefile-targets" href="#FATE-Makefile-targets">3.1 FATE Makefile targets</a></li>
    <li><a name="toc-FATE-Makefile-variables" href="#FATE-Makefile-variables">3.2 FATE Makefile variables</a></li>
  </ul></li>
  <li><a name="toc-Automated-Tests" href="#Automated-Tests">4. Automated Tests</a>
  <ul class="toc">
    <li><a name="toc-Testing-Profiles" href="#Testing-Profiles">4.1 Testing Profiles</a></li>
    <li><a name="toc-Special-Instances" href="#Special-Instances">4.2 Special Instances</a></li>
    <li><a name="toc-Submitting-Reports" href="#Submitting-Reports">4.3 Submitting Reports</a></li>
  </ul>
</li>
</ul>
</div>

<a name="Introduction"></a>
<h1 class="chapter"><a href="fate.html#toc-Introduction">1. Introduction</a></h1>

<p>FATE provides a regression testsuite embedded within the Libav build system.
It can be run locally and optionally configured to send reports to a web
aggregator and viewer <a href="http://fate.libav.org">http://fate.libav.org</a>.
</p>
<p>It is advised to run FATE before submitting patches to the current codebase
and provide new tests when submitting patches to add additional features.
</p>
<a name="Running-FATE"></a>
<h1 class="chapter"><a href="fate.html#toc-Running-FATE">2. Running FATE</a></h1>

<a name="Samples-and-References"></a>
<h2 class="section"><a href="fate.html#toc-Samples-and-References">2.1 Samples and References</a></h2>
<p>In order to run, FATE needs a large amount of data (samples and references)
that is provided separately from the actual source distribution.
</p>
<p>To inform the build system about the testsuite location, pass
&lsquo;<samp>--samples=&lt;path to the samples&gt;</samp>&rsquo; to <code>configure</code> or set the
<var>SAMPLES</var> Make variable or the <var>LIBAV_SAMPLES</var> environment variable
to a suitable value.
</p>
<p>To use a custom wrapper to run the test, pass &lsquo;<samp>--target-exec</samp>&rsquo; to
<code>configure</code> or set the <var>TARGET_EXEC</var> Make variable.
</p>
<p>The dataset is available through <code>rsync</code>, is possible to fetch
the current sample using the straight rsync command or through a specific
<a href="#Makefile-target">Makefile target</a>.
</p>
<table><tr><td>&nbsp;</td><td><pre class="example"># rsync -aL rsync://fate-suite.libav.org/fate-suite/ fate-suite
</pre></td></tr></table>

<table><tr><td>&nbsp;</td><td><pre class="example"># make fate-rsync SAMPLES=fate-suite
</pre></td></tr></table>


<a name="Manual-Run"></a>
<h1 class="chapter"><a href="fate.html#toc-Manual-Run">3. Manual Run</a></h1>
<p>FATE regression test can be run through <code>make</code>.
Specific Makefile targets and Makefile variables are available:
</p>
<p><a name="Makefile-target"></a>
</p><a name="FATE-Makefile-targets"></a>
<h2 class="section"><a href="fate.html#toc-FATE-Makefile-targets">3.1 FATE Makefile targets</a></h2>

<dl compact="compact">
<dt> &lsquo;<samp>fate-list</samp>&rsquo;</dt>
<dd><p>List all fate/regression test targets.
</p>
</dd>
<dt> &lsquo;<samp>fate-rsync</samp>&rsquo;</dt>
<dd><p>Shortcut to download the fate test samples to the specified testsuite location.
</p>
</dd>
<dt> &lsquo;<samp>fate</samp>&rsquo;</dt>
<dd><p>Run the FATE test suite (requires the fate-suite dataset).
</p></dd>
</dl>

<a name="FATE-Makefile-variables"></a>
<h2 class="section"><a href="fate.html#toc-FATE-Makefile-variables">3.2 FATE Makefile variables</a></h2>
<dl compact="compact">
<dt> &lsquo;<samp>V</samp>&rsquo;</dt>
<dd><p>Verbosity level, can be set to 0, 1 or 2.
</p>
<dl compact="compact">
<dt> &lsquo;<samp>0</samp>&rsquo;</dt>
<dd><p>show just the test arguments
</p>
</dd>
<dt> &lsquo;<samp>1</samp>&rsquo;</dt>
<dd><p>show just the command used in the test
</p>
</dd>
<dt> &lsquo;<samp>2</samp>&rsquo;</dt>
<dd><p>show everything
</p></dd>
</dl>

</dd>
<dt> &lsquo;<samp>SAMPLES</samp>&rsquo;</dt>
<dd><p>Specify or override the path to the FATE samples at make time, it has a
meaning only while running the regression tests.
</p>
</dd>
<dt> &lsquo;<samp>THREADS</samp>&rsquo;</dt>
<dd><p>Specify how many threads to use while running regression tests, it is
quite useful to detect thread-related regressions.
</p>
</dd>
<dt> &lsquo;<samp>THREAD_TYPE</samp>&rsquo;</dt>
<dd><p>Specify which threading strategy test, either <var>slice</var> or <var>frame</var>,
by default <var>slice+frame</var>
</p>
</dd>
<dt> &lsquo;<samp>CPUFLAGS</samp>&rsquo;</dt>
<dd><p>Specify a mask to be applied to autodetected CPU flags.
</p>
</dd>
<dt> &lsquo;<samp>TARGET_EXEC</samp>&rsquo;</dt>
<dd><p>Specify or override the wrapper used to run the tests.
</p>
</dd>
<dt> &lsquo;<samp>GEN</samp>&rsquo;</dt>
<dd><p>Set to <var>1</var> to generate the missing or mismatched references.
</p></dd>
</dl>

<table><tr><td>&nbsp;</td><td><pre class="example">    make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
</pre></td></tr></table>

<a name="Automated-Tests"></a>
<h1 class="chapter"><a href="fate.html#toc-Automated-Tests">4. Automated Tests</a></h1>
<p>In order to automatically testing specific configurations, e.g. multiple
compilers, <code>tests/fate.sh</code> is provided.
</p>
<p>This shell script builds Libav, runs the regression tests and prepares
a report that can be sent to <a href="http://fate.libav.org/">http://fate.libav.org/</a> or directly
examined locally.
</p>
<a name="Testing-Profiles"></a>
<h2 class="section"><a href="fate.html#toc-Testing-Profiles">4.1 Testing Profiles</a></h2>
<p>The configuration file passed to <code>fate.sh</code> is shell scripts as well.
</p>
<p>It must provide at least a <var>slot</var> identifier, the <var>repo</var> from
which fetch the sources, the <var>samples</var> directory, a <var>workdir</var> with
enough space to build and run all the tests.
Optional submit command <var>fate_recv</var> and a <var>comment</var> to describe
the testing profile are available.
</p>
<p>Additional optional parameter to tune the Libav building and reporting process
can be passed.
</p>
<table><tr><td>&nbsp;</td><td><pre class="example">slot=                                   # some unique identifier
repo=git://git.libav.org/libav.git      # the source repository
samples=/path/to/fate/samples
workdir=                                # directory in which to do all the work
fate_recv=&quot;ssh -T fate@fate.libav.org&quot;  # command to submit report
comment=                                # optional description
build_only=     # set to &quot;yes&quot; 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'
</pre></td></tr></table>

<a name="Special-Instances"></a>
<h2 class="section"><a href="fate.html#toc-Special-Instances">4.2 Special Instances</a></h2>
<p>The <var>TARGET_EXEC</var> option provides a way to run FATE wrapped in
<code>valgrind</code>, <code>qemu-user</code> or <code>wine</code> or on remote targets
through <code>ssh</code>.
</p>
<a name="Submitting-Reports"></a>
<h2 class="section"><a href="fate.html#toc-Submitting-Reports">4.3 Submitting Reports</a></h2>
<p>In order to send reports you need to create an <code>ssh</code> key and send it
to <a href="mailto:root@libav.org">root@libav.org</a>.
The current server fingerprint is <var>a4:99:d7:d3:1c:92:0d:56:d6:d5:61:be:01:ae:7d:e6</var>
</p><footer class="footer pagination-right">
<span class="label label-info">This document was generated by <em>Sebastian Ramacher</em> on <em>February 18, 2018</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.</span></footer></div>