On Wed, Nov 22, 2017 at 7:28 AM, Junio C Hamano <gitster@xxxxxxxxx> wrote: > Jonathan Nieder <jrnieder@xxxxxxxxx> 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. I was going to resend without the comment after Jonathan's first email, but I am ok with either your improved comment or without any comment. Thanks.