Merge pull request #92 from stanislaw/develop

docs: switch to printf in all examples

docs/05-check-commands.rst

@@ -9,9 +9,6 @@ For all of the examples below, please note:
 
 - ``.check`` extension is chosen arbitrarily. FileCheck can work with any file
   names.
-- When ``echo`` is used with the ``-e`` flag, the ``\n`` symbols are
-  treated as newline symbols. We use it to simulate multiline input for
-  FileCheck.
 
 CHECK
 -----
@@ -31,7 +28,7 @@ Valid input results in the exit code ``0`` that indicates success:
 
 .. code-block:: bash
 
-    echo -e "String1\nString2\nString3" | filecheck CHECK.check
+    printf "String1\nString2\nString3" | filecheck CHECK.check
     /Users/Stanislaw/.pyenv/versions/3.5.0/bin/filecheck
 
 Invalid input results in the exit code ``1`` and error message:
@@ -120,14 +117,14 @@ Check file ``CHECK-NEXT.check``:
 
 .. code-block:: bash
 
-    $ echo -e "String1\nString2" | filecheck CHECK-NEXT.check
+    $ printf "String1\nString2" | filecheck CHECK-NEXT.check
     ...filecheck
     $ echo $?
     0
 
 .. code-block:: bash
 
-    $ echo -e "String1\nfoo\nString2" | filecheck CHECK-NEXT.check
+    $ printf "String1\nfoo\nString2" | filecheck CHECK-NEXT.check
     ...filecheck
     CHECK-NEXT.check:2:13: error: CHECK-NEXT: is not on the line after the previous match
     CHECK-NEXT: String2
@@ -159,14 +156,16 @@ In the following example, there is an empty line so the test will pass:
 
 .. code-block:: bash
 
-    echo -e "String1\n\nString2" | filecheck CHECK-EMPTY.check
+    $ printf "String1\n\nString2" | filecheck CHECK-EMPTY.check
     ...filecheck
     $ echo $?
     0
 
 If the empty line is removed, the test will fail:
 
-    echo -e "String1\nString2" | filecheck CHECK-EMPTY.check
+.. code-block:: bash
+
+    $ printf "String1\nString2" | filecheck CHECK-EMPTY.check
     ...filecheck
     ...CHECK-EMPTY.check:2:13: error: CHECK-EMPTY: expected string not found in input
     CHECK-EMPTY:

tests/integration/tests/check_commands/CHECK/failure/09-not-enough-input-for-all-checks/CHECK.itest

@@ -0,0 +1,12 @@
+; RUN: printf "String1" | (%FILECHECK_EXEC %S/CHECK.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s --strict-whitespace --match-full-lines
+; CHECK:{{^.*}}FileCheck{{(\.py)?$}}
+// TODO: Something wrong with the greediness here:
+; CHECK***:{{^.*}}CHECK.check:2:8: error: CHECK***: expected string not found in input
+; CHECK:{{^.*}}
+// TODO: And here:
+; CHECK:{{.*}}String2
+; CHECK:       ^
+; CHECK:<stdin>:1:8: note: scanning from here
+; CHECK:String1
+; CHECK:       ^
+; CHECK-EMPTY:

tests/integration/tests/check_commands/CHECK/failure/10-edge-case-no-newline-in-py/CHECK.check

@@ -0,0 +1,3 @@
+CHECK: String1
+CHECK: String2
+CHECK: String3

tests/integration/tests/examples/check-commands/CHECK-EMPTY/Failure/CHECK-EMPTY.itest-py

@@ -1,4 +1,4 @@
-; RUN: echo -e "String1\nString2" | (%FILECHECK_EXEC %S/CHECK-EMPTY.check 2>&1; test $? = 1) | %FILECHECK_EXEC %s
+; RUN: printf "String1\nString2" | (%FILECHECK_EXEC %S/CHECK-EMPTY.check 2>&1; test $? = 1) | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK: {{^.*}}CHECK-EMPTY.check:2:13: error: CHECK-EMPTY: expected string not found in input
 ; CHECK: CHECK-EMPTY:

tests/integration/tests/examples/check-commands/CHECK-EMPTY/Success/CHECK-EMPTY.itest

@@ -1,3 +1,3 @@
-; RUN: echo -e "String1\n\nString2" | %FILECHECK_EXEC %S/CHECK-EMPTY.check | %FILECHECK_EXEC %s
+; RUN: printf "String1\n\nString2" | %FILECHECK_EXEC %S/CHECK-EMPTY.check | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK-EMPTY:

tests/integration/tests/examples/check-commands/CHECK-NEXT/Failure/CHECK-NEXT.itest

@@ -1,4 +1,4 @@
-; RUN: echo -e "String1\nfoo\nString2" | (%FILECHECK_EXEC %S/CHECK-NEXT.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
+; RUN: printf "String1\nfoo\nString2" | (%FILECHECK_EXEC %S/CHECK-NEXT.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
 
 ; CHECK: {{.*}}CHECK-NEXT.check:2:13: error: CHECK-NEXT: is not on the line after the previous match
 ; CHECK: CHECK-NEXT: String2

tests/integration/tests/examples/check-commands/CHECK-NEXT/Success/CHECK-NEXT.itest

@@ -1,3 +1,3 @@
-; RUN: echo -e "String1\nString2" | %FILECHECK_EXEC %S/CHECK-NEXT.check | %FILECHECK_EXEC %s
+; RUN: printf "String1\nString2" | %FILECHECK_EXEC %S/CHECK-NEXT.check | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK-EMPTY:

tests/integration/tests/examples/check-commands/CHECK-NOT/Failure/CHECK-NOT.itest

@@ -1,4 +1,4 @@
-; RUN: echo -e "String3" | (%FILECHECK_EXEC %S/CHECK-NOT.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
+; RUN: printf "String3" | (%FILECHECK_EXEC %S/CHECK-NOT.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
 ; CHECK: {{.*}}CHECK-NOT.check:3:12: error: CHECK-NOT: excluded string found in input
 ; CHECK: CHECK-NOT: String3
 ; CHECK:            ^

tests/integration/tests/examples/check-commands/CHECK-NOT/Success/CHECK-NOT.itest

@@ -1,3 +1,3 @@
-; RUN: echo -e "String4" | %FILECHECK_EXEC %S/CHECK-NOT.check | %FILECHECK_EXEC %s
+; RUN: printf "String4" | %FILECHECK_EXEC %S/CHECK-NOT.check | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK-EMPTY:

tests/integration/tests/examples/check-commands/CHECK/Failure/CHECK.itest

@@ -1,4 +1,4 @@
-; RUN: echo -e "String1" | (%FILECHECK_EXEC %S/CHECK.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
+; RUN: printf "String1" | (%FILECHECK_EXEC %S/CHECK.check 2>&1; test $? = 1;) | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK: {{.*}}CHECK.check:2:8: error: CHECK: expected string not found in input
 ; CHECK: CHECK: String2

tests/integration/tests/examples/check-commands/CHECK/Success/CHECK.itest

@@ -1,3 +1,3 @@
-; RUN: echo -e "String1\nString2\nString3" | %FILECHECK_EXEC %S/CHECK.check | %FILECHECK_EXEC %s
+; RUN: printf "String1\nString2\nString3" | %FILECHECK_EXEC %S/CHECK.check | %FILECHECK_EXEC %s
 ; CHECK: {{^.*}}FileCheck{{(\.py)?$}}
 ; CHECK-EMPTY: