[FFmpeg-devel] [PATCH] Added additional note to fate.texi to describe the importance of not checking out files from git with core.autocrlf set to true

[Lou Logan]

On Fri, 21 Apr 2017 16:05:16 -0700
Aaron Levinson <alevinsn at aracnet.com> wrote:

> From 7ea6455cd52ffe561f94bf03f48c4c2cf61b33c5 Mon Sep 17 00:00:00 2001
> From: Aaron Levinson <alevinsn at aracnet.com>
> Date: Fri, 21 Apr 2017 15:55:11 -0700
> Subject: [PATCH] Added additional note to fate.texi to describe the importance
>  of not checking out files from git with core.autocrlf set to true
> 
> Purpose: Added additional note to fate.texi to describe the importance
> of not checking out files from git with core.autocrlf set to true.
> When CRLF is used for line endings, this causes the source FATE test,
> which uses check-source.sh, to fail.  The issue has to do with the use
> of git grep, which doesn't appear to be able to handle CRLF line
> endings.  Older versions of check-source.sh used grep directly, which
> seems to do a better job of handling CRLF line endings.
> 
> Note: thanks to Hendrik Leppkes for suggestion that the issue with
> FATE failing was caused by CRLF line endings.
> ---
>  doc/fate.texi | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/fate.texi b/doc/fate.texi
> index 7a96c25..80fac0a 100644
> --- a/doc/fate.texi
> +++ b/doc/fate.texi
> @@ -77,6 +77,15 @@ FATE_SAMPLES=fate-suite/ make fate
>  @float NOTE
>  Do not put a '~' character in the samples path to indicate a home
>  directory. Because of shell nuances, this will cause FATE to fail.
> +
> +In addition, FATE will fail if files are checked out from git such
> +that CRLF is used for line endings.  This will occur on Windows when
> +git is installed using the default options, because that causes git's
> +core.autocrlf setting to be set to 'true'.  Make sure to set
> +core.autocrlf to 'input' or 'false', or, in the case that the
> +repository has already been cloned, it is possible to get past this by
> +executing the following command in the top-level ffmpeg directory:
> + at command{find -name '*.h' -type f | xargs dos2unix}.
>  @end float

This is a non-blocking minor comment, but it would be nice to add some
additional markup to core.autocrlf and true/false. For a list see:

<https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Indicating.html#Indicating>