From: Junio C Hamano Date: Wed, 22 Nov 2017 06:28:27 GMT Subject: Re: [PATCH 1/2] Git/Packet.pm: rename packet_required_key_val_read() Message-ID: In-Reply-To: <20171122051014.GA7625@aiede.mtv.corp.google.com> Jonathan Nieder writes: >>> This comment doesn't tell me how to use the function. How do I detect >>> whether it successfully read a line? What do the return values >>> represent? What happens if the line it read doesn't match the key? >> >> Would this work for both of you? >> >> # 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. > > Yes, thank you. Heh. I actually was expecting a different response: "that describes what the reader can easily read out of the implementation and is useless", though.