Merge branch 'ls/filter-process' into maint

Doc update.

* ls/filter-process:
t0021: fix flaky test
docs: warn about possible '=' in clean/smudge filter process values

diff --combined t/t0021-conversion.sh
index 34891c4b1ad1c53ebc78b18484c7c146659ce68d,6cc678846ed663a57571d5f265e73bff0d150870..161f5604464d2f963e60af54eedea3f91be041fa
--- 1/t/t0021-conversion.sh
--- 2/t/t0021-conversion.sh
+++ b/t/t0021-conversion.sh
@@@ -4,17 -4,15 +4,17 @@@ test_description='blob conversion via g
  
  . ./test-lib.sh
  
 -TEST_ROOT="$(pwd)"
 +TEST_ROOT="$PWD"
 +PATH=$TEST_ROOT:$PATH
  
 -cat <<EOF >"$TEST_ROOT/rot13.sh"
 -#!$SHELL_PATH
 +write_script <<\EOF "$TEST_ROOT/rot13.sh"
  tr \
    'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' \
    'nopqrstuvwxyzabcdefghijklmNOPQRSTUVWXYZABCDEFGHIJKLM'
  EOF
 -chmod +x "$TEST_ROOT/rot13.sh"
 +
 +write_script rot13-filter.pl "$PERL_PATH" \
 +      <"$TEST_DIRECTORY"/t0021/rot13-filter.pl
  
  generate_random_characters () {
        LEN=$1
@@@ -66,7 -64,7 +66,7 @@@ test_cmp_exclude_clean () 
  # is equal to the committed content.
  test_cmp_committed_rot13 () {
        test_cmp "$1" "$2" &&
 -      "$TEST_ROOT/rot13.sh" <"$1" >expected &&
 +      rot13.sh <"$1" >expected &&
        git cat-file blob :"$2" >actual &&
        test_cmp expected actual
  }
@@@ -93,7 -91,7 +93,7 @@@ test_expect_success setup 
        git checkout -- test test.t test.i &&
  
        echo "content-test2" >test2.o &&
-       echo "content-test3 - filename with special characters" >"test3 '\''sq'\'',\$x.o"
+       echo "content-test3 - filename with special characters" >"test3 '\''sq'\'',\$x=.o"
  '
  
  script='s/^\$Id: \([0-9a-f]*\) \$/\1/p'
@@@ -342,7 -340,7 +342,7 @@@ test_expect_success 'diff does not reus
  '
  
  test_expect_success PERL 'required process filter should filter data' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        test_config_global filter.protocol.required true &&
        rm -rf repo &&
        mkdir repo &&
@@@ -350,20 -348,21 +350,20 @@@
                cd repo &&
                git init &&
  
 -              echo "git-stderr.log" >.gitignore &&
                echo "*.r filter=protocol" >.gitattributes &&
                git add . &&
 -              git commit . -m "test commit 1" &&
 +              git commit -m "test commit 1" &&
                git branch empty-branch &&
  
                cp "$TEST_ROOT/test.o" test.r &&
                cp "$TEST_ROOT/test2.o" test2.r &&
                mkdir testsubdir &&
-               cp "$TEST_ROOT/test3 '\''sq'\'',\$x.o" "testsubdir/test3 '\''sq'\'',\$x.r" &&
+               cp "$TEST_ROOT/test3 '\''sq'\'',\$x=.o" "testsubdir/test3 '\''sq'\'',\$x=.r" &&
                >test4-empty.r &&
  
                S=$(file_size test.r) &&
                S2=$(file_size test2.r) &&
-               S3=$(file_size "testsubdir/test3 '\''sq'\'',\$x.r") &&
+               S3=$(file_size "testsubdir/test3 '\''sq'\'',\$x=.r") &&
  
                filter_git add . &&
                cat >expected.log <<-EOF &&
@@@ -372,35 -371,20 +372,20 @@@
                        IN: clean test.r $S [OK] -- OUT: $S . [OK]
                        IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
                        IN: clean test4-empty.r 0 [OK] -- OUT: 0  [OK]
-                       IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
+                       IN: clean testsubdir/test3 '\''sq'\'',\$x=.r $S3 [OK] -- OUT: $S3 . [OK]
                        STOP
                EOF
                test_cmp_count expected.log rot13-filter.log &&
  
-               filter_git commit -m "test commit 2" &&
-               cat >expected.log <<-EOF &&
-                       START
-                       init handshake complete
-                       IN: clean test.r $S [OK] -- OUT: $S . [OK]
-                       IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
-                       IN: clean test4-empty.r 0 [OK] -- OUT: 0  [OK]
-                       IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
-                       IN: clean test.r $S [OK] -- OUT: $S . [OK]
-                       IN: clean test2.r $S2 [OK] -- OUT: $S2 . [OK]
-                       IN: clean test4-empty.r 0 [OK] -- OUT: 0  [OK]
-                       IN: clean testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
-                       STOP
-               EOF
-               test_cmp_count expected.log rot13-filter.log &&
- 
-               rm -f test2.r "testsubdir/test3 '\''sq'\'',\$x.r" &&
+               git commit -m "test commit 2" &&
+               rm -f test2.r "testsubdir/test3 '\''sq'\'',\$x=.r" &&
  
                filter_git checkout --quiet --no-progress . &&
                cat >expected.log <<-EOF &&
                        START
                        init handshake complete
                        IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
-                       IN: smudge testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
+                       IN: smudge testsubdir/test3 '\''sq'\'',\$x=.r $S3 [OK] -- OUT: $S3 . [OK]
                        STOP
                EOF
                test_cmp_exclude_clean expected.log rot13-filter.log &&
@@@ -421,20 -405,20 +406,20 @@@
                        IN: smudge test.r $S [OK] -- OUT: $S . [OK]
                        IN: smudge test2.r $S2 [OK] -- OUT: $S2 . [OK]
                        IN: smudge test4-empty.r 0 [OK] -- OUT: 0  [OK]
-                       IN: smudge testsubdir/test3 '\''sq'\'',\$x.r $S3 [OK] -- OUT: $S3 . [OK]
+                       IN: smudge testsubdir/test3 '\''sq'\'',\$x=.r $S3 [OK] -- OUT: $S3 . [OK]
                        STOP
                EOF
                test_cmp_exclude_clean expected.log rot13-filter.log &&
  
                test_cmp_committed_rot13 "$TEST_ROOT/test.o" test.r &&
                test_cmp_committed_rot13 "$TEST_ROOT/test2.o" test2.r &&
-               test_cmp_committed_rot13 "$TEST_ROOT/test3 '\''sq'\'',\$x.o" "testsubdir/test3 '\''sq'\'',\$x.r"
+               test_cmp_committed_rot13 "$TEST_ROOT/test3 '\''sq'\'',\$x=.o" "testsubdir/test3 '\''sq'\'',\$x=.r"
        )
  '
  
  test_expect_success PERL 'required process filter takes precedence' '
        test_config_global filter.protocol.clean false &&
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean" &&
        test_config_global filter.protocol.required true &&
        rm -rf repo &&
        mkdir repo &&
@@@ -459,7 -443,7 +444,7 @@@
  '
  
  test_expect_success PERL 'required process filter should be used only for "clean" operation only' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean" &&
        rm -rf repo &&
        mkdir repo &&
        (
@@@ -494,7 -478,7 +479,7 @@@
  '
  
  test_expect_success PERL 'required process filter should process multiple packets' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        test_config_global filter.protocol.required true &&
  
        rm -rf repo &&
@@@ -514,7 -498,7 +499,7 @@@
                for FILE in "$TEST_ROOT"/*.file
                do
                        cp "$FILE" . &&
 -                      "$TEST_ROOT/rot13.sh" <"$FILE" >"$FILE.rot13"
 +                      rot13.sh <"$FILE" >"$FILE.rot13"
                done &&
  
                echo "*.file filter=protocol" >.gitattributes &&
@@@ -554,7 -538,7 +539,7 @@@
  '
  
  test_expect_success PERL 'required process filter with clean error should fail' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        test_config_global filter.protocol.required true &&
        rm -rf repo &&
        mkdir repo &&
@@@ -573,7 -557,7 +558,7 @@@
  '
  
  test_expect_success PERL 'process filter should restart after unexpected write failure' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        rm -rf repo &&
        mkdir repo &&
        (
@@@ -617,14 -601,14 +602,14 @@@
  
                # Smudge failed
                ! test_cmp smudge-write-fail.o smudge-write-fail.r &&
 -              "$TEST_ROOT/rot13.sh" <smudge-write-fail.o >expected &&
 +              rot13.sh <smudge-write-fail.o >expected &&
                git cat-file blob :smudge-write-fail.r >actual &&
                test_cmp expected actual
        )
  '
  
  test_expect_success PERL 'process filter should not be restarted if it signals an error' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        rm -rf repo &&
        mkdir repo &&
        (
@@@ -663,7 -647,7 +648,7 @@@
  '
  
  test_expect_success PERL 'process filter abort stops processing of all further files' '
 -      test_config_global filter.protocol.process "$TEST_DIRECTORY/t0021/rot13-filter.pl clean smudge" &&
 +      test_config_global filter.protocol.process "rot13-filter.pl clean smudge" &&
        rm -rf repo &&
        mkdir repo &&
        (

diff --combined t/t0021/rot13-filter.pl
index 4d5697ee51c673abbe8a1a90b58bf5b7b9856ce1,02b3363fd9d1bb040c441b9a589afb3dfc8f8ed9..617f581e56cac95191d6f1301566fa6671ecaf6f
mode 100644,100755..100644
--- 1/t/t0021/rot13-filter.pl
--- 2/t/t0021/rot13-filter.pl
+++ b/t/t0021/rot13-filter.pl
@@@ -1,3 -1,4 +1,3 @@@
 -#!/usr/bin/perl
  #
  # Example implementation for the Git filter protocol version 2
  # See Documentation/gitattributes.txt, section "Filter Protocol"
@@@ -21,7 -22,6 +21,7 @@@
  
  use strict;
  use warnings;
 +use IO::File;
  
  my $MAX_PACKET_CONTENT_SIZE = 65516;
  my @capabilities            = @ARGV;
@@@ -109,14 -109,18 +109,18 @@@ print $debug "init handshake complete\n
  $debug->flush();
  
  while (1) {
-       my ($command) = packet_txt_read() =~ /^command=([^=]+)$/;
+       my ($command) = packet_txt_read() =~ /^command=(.+)$/;
        print $debug "IN: $command";
        $debug->flush();
  
-       my ($pathname) = packet_txt_read() =~ /^pathname=([^=]+)$/;
+       my ($pathname) = packet_txt_read() =~ /^pathname=(.+)$/;
        print $debug " $pathname";
        $debug->flush();
  
+       if ( $pathname eq "" ) {
+               die "bad pathname '$pathname'";
+       }
+ 
        # Flush
        packet_bin_read();