[FFmpeg-devel] [PATCH] Fix: explanation on how to run make fate. (PR #20905)

[Adam Koszek via ffmpeg-devel <ffmpeg-devel@ffmpeg.org>]

PR #20905 opened by Adam Koszek (wkoszek)
URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/20905
Patch URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/20905.patch

Without running configure, it didn't work for me anymore.
On ffmpeg-devel the feedback was to run configure.
I'm thus compressing the explanation a little bit here.
Also new users should just get 1 preferred and supported way
to run stuff, so I'm just showing 2 examples of running fate
with make/environment variable settings.


>From ae00d070df0721f37cc0376f02cd629e293f7290 Mon Sep 17 00:00:00 2001
From: Adam Koszek <adam@koszek.com>
Date: Wed, 12 Nov 2025 16:52:47 -0800
Subject: [PATCH] Fix explanation on how to run fate.

Without running configure, it didn't work for me anymore.
On ffmpeg-devel the feedback was to run configure.
I'm thus compressing the explanation a little bit here.
Also new users should just get 1 preferred and supported way
to run stuff, so I'm just showing 2 examples of running fate
with make/environment variable settings.
---
 doc/fate.texi | 22 ++++------------------
 1 file changed, 4 insertions(+), 18 deletions(-)

diff --git a/doc/fate.texi b/doc/fate.texi
index 7a2e0edfcc..05979d9a60 100644
--- a/doc/fate.texi
+++ b/doc/fate.texi
@@ -44,19 +44,7 @@ targets and variables.
 
 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.
-Use this command from the top-level source directory:
-
-@example
-make fate-rsync SAMPLES=fate-suite/
-make fate       SAMPLES=fate-suite/
-@end example
-
-The above commands set the samples location by passing a makefile
-variable via command line. It is also possible to set the samples
-location at source configuration time by invoking configure with
-@option{--samples=<path to the samples directory>}. Afterwards you can
-invoke the makefile targets without setting the @var{SAMPLES} makefile
-variable. This is illustrated by the following commands:
+Use this command from the top-level source directory of FFmpeg:
 
 @example
 ./configure --samples=fate-suite/
@@ -64,13 +52,11 @@ make fate-rsync
 make fate
 @end example
 
-Yet another way to tell FATE about the location of the sample
-directory is by making sure the environment variable FATE_SAMPLES
-contains the path to your samples directory. This can be achieved
-by e.g. putting that variable in your shell profile or by setting
-it in your interactive session.
+You can pass different samples directory to @code{make fate-rsync} and
+@code{make fate} later. Those two are equivalent:
 
 @example
+make fate SAMPLES=fate-suite/
 FATE_SAMPLES=fate-suite/ make fate
 @end example
 
-- 
2.49.1

_______________________________________________
ffmpeg-devel mailing list -- ffmpeg-devel@ffmpeg.org
To unsubscribe send an email to ffmpeg-devel-leave@ffmpeg.org