Git/Packet: clarify that packet_required_key_val_read allows EOF

diff --git a/perl/Git/Packet.pm b/perl/Git/Packet.pm
index 255b28c0988376ab7065078f411d5a53752bbf42..14dd06d1d4afde0dbf9a70251d49ae672e000c39 100644 (file)
--- a/perl/Git/Packet.pm
+++ b/perl/Git/Packet.pm
@@ -17,7 +17,7 @@ BEGIN
                        packet_compare_lists
                        packet_bin_read
                        packet_txt_read
-                       packet_required_key_val_read
+                       packet_key_val_read
                        packet_bin_write
                        packet_txt_write
                        packet_flush
@@ -83,7 +83,12 @@ sub packet_txt_read {
        return ( $res, $buf );
 }
 
-sub packet_required_key_val_read {
+# Read a text packet, expecting that it is in the form "key=value" for
+# the given $key.  An EOF does not trigger any error and is reported
+# back to the caller (like packet_txt_read() does).  Die if the "key"
+# part of "key=value" does not match the given $key, or the value part
+# is empty.
+sub packet_key_val_read {
        my ( $key ) = @_;
        my ( $res, $buf ) = packet_txt_read();
        unless ( $res == -1 or ( $buf =~ s/^$key=// and $buf ne '' ) ) {