diff mbox

[FFmpeg-devel] doc: Enhanced fate.texi to reference Windows line endings section from git-howto.texi

Message ID a54c8755-08cb-c66f-4492-4985f029412d@aracnet.com
State New
Headers show

Commit Message

Aaron Levinson May 3, 2017, 7:46 p.m. UTC 
From 345a98d31c6c758f0f82edab1b502cd8aeb3354b Mon Sep 17 00:00:00 2001
From: Aaron Levinson <alevinsn@aracnet.com>
Date: Wed, 3 May 2017 12:38:39 -0700
Subject: [PATCH] doc: Enhanced fate.texi to reference Windows line endings
 section from git-howto.texi

Purpose: Enhanced fate.texi to indicate that FATE will fail if files
are checked out with Windows line endings (CRLF) and added reference
to Windows line endings anchor in git-howto.texi for how to address.
Also added Windows line endings anchor in git-howto.texi.

The exact problem caused by CRLF endings occurs with check-source.sh,
which uses git grep.  git grep doesn't appear to be able to handle
CRLF line endings.

Note: thanks to Hendrik Leppkes for suggestion that the issue with
FATE failing was caused by CRLF line endings.

Signed-off-by: Aaron Levinson <alevinsn@aracnet.com>
---
 doc/fate.texi      | 5 +++++
 doc/git-howto.texi | 1 +
 2 files changed, 6 insertions(+)
diff mbox

Patch

diff --git a/doc/fate.texi b/doc/fate.texi
index 7a96c25..c498336 100644
--- a/doc/fate.texi
+++ b/doc/fate.texi
@@ -77,6 +77,11 @@  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 @kbd{@key{CR}@key{LF}} is used for line endings.  Please refer to
+@ref{Windows line endings,,Windows line endings,git-howto} in the
+FFmpeg documentation for more information.
 @end float
 
 To use a custom wrapper to run the test, pass @option{--target-exec} to
diff --git a/doc/git-howto.texi b/doc/git-howto.texi
index 2b4fb80..f2b6182 100644
--- a/doc/git-howto.texi
+++ b/doc/git-howto.texi
@@ -80,6 +80,7 @@  create patches after making a read-only ffmpeg-web clone:
 git clone git://ffmpeg.org/ffmpeg-web <target>
 @end example
 
+@anchor{Windows line endings}
 Make sure that you do not have Windows line endings in your checkouts,
 otherwise you may experience spurious compilation failures. One way to
 achieve this is to run