diff mbox series

[FFmpeg-devel,3/3] tests: add README.md file with simple instructions

Message ID 20220403135942.303691-1-stefasab@gmail.com
State New
Headers show
Series None | expand

Commit Message

Stefano Sabatini April 3, 2022, 1:59 p.m. UTC
---
 tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 tests/README.md

Comments

Thilo Borgmann April 4, 2022, 8:30 a.m. UTC | #1
Hi,

Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> ---
>   tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 48 insertions(+)
>   create mode 100644 tests/README.md
> 
> diff --git a/tests/README.md b/tests/README.md
> new file mode 100644
> index 0000000000..4bcae0b403
> --- /dev/null
> +++ b/tests/README.md

currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?

-Thilo
Stefano Sabatini April 5, 2022, 9:40 p.m. UTC | #2
On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
> Hi,
> 
> Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> > ---
> >   tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> >   1 file changed, 48 insertions(+)
> >   create mode 100644 tests/README.md
> > 
> > diff --git a/tests/README.md b/tests/README.md
> > new file mode 100644
> > index 0000000000..4bcae0b403
> > --- /dev/null
> > +++ b/tests/README.md
> 
> currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?

Makes sense, totally missed it, updated.
Thilo Borgmann April 6, 2022, 7:24 a.m. UTC | #3
Am 05.04.22 um 23:40 schrieb Stefano Sabatini:
> On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
>> Hi,
>>
>> Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
>>> ---
>>>    tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>>>    1 file changed, 48 insertions(+)
>>>    create mode 100644 tests/README.md
>>>
>>> diff --git a/tests/README.md b/tests/README.md
>>> new file mode 100644
>>> index 0000000000..4bcae0b403
>>> --- /dev/null
>>> +++ b/tests/README.md
>>
>> currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?
> 
> Makes sense, totally missed it, updated.

Pushed, thanks!

-Thilo
Stefano Sabatini April 7, 2022, 10:36 p.m. UTC | #4
On date Wednesday 2022-04-06 09:24:16 +0200, Thilo Borgmann wrote:
> Am 05.04.22 um 23:40 schrieb Stefano Sabatini:
> > On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
> > > Hi,
> > > 
> > > Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> > > > ---
> > > >    tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> > > >    1 file changed, 48 insertions(+)
> > > >    create mode 100644 tests/README.md
> > > > 
> > > > diff --git a/tests/README.md b/tests/README.md
> > > > new file mode 100644
> > > > index 0000000000..4bcae0b403
> > > > --- /dev/null
> > > > +++ b/tests/README.md
> > > 
> > > currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?
> > 
> > Makes sense, totally missed it, updated.
> 
> Pushed, thanks!

Thanks!
diff mbox series

Patch

diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000000..4bcae0b403
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,48 @@ 
+FFmpeg tests
+============
+
+Tests are useful to make sure that code changes do not introduce regressions.
+
+## FATE tests
+
+FATE (FFmpeg Automated Test Environment) is the system used to test
+regressions and should be used for new changes which affect the API or
+components behavior.
+
+To run all tests, run the following command from the commandline:
+```
+make fate
+```
+
+To get the complete list of tests:
+```
+make fate-list
+```
+
+You can specify a subset of tests to run by specifying the
+corresponding element form the list with the `fate-` prefix, e.g.:
+```
+make fate-ffprobe_compact fate-ffprobe_xml
+```
+
+## FATE samples
+
+By default, FFmpeg uses only the standalone tests. To use the
+collected FATE samples, you need download and configure the tests with
+the FATE samples path.
+
+To upload or update the samples, run the command:
+```
+make fate-rsync SAMPLES=/path/to/samples
+```
+
+Then you need to setup the path where the samples are located, either
+when configuring with:
+```
+./configure --samples=path/to/fate/samples
+```
+
+or when running the tests with:
+```
+FATE_SAMPLES=path/to/fate/samples make fate
+```