Clarify the behavior of BIO_gets() a bit more
authorBenjamin Kaduk <bkaduk@akamai.com>
Tue, 29 Mar 2016 19:56:44 +0000 (14:56 -0500)
committerRich Salz <rsalz@openssl.org>
Tue, 29 Mar 2016 22:10:49 +0000 (18:10 -0400)
commit6be630b9c514bd19eb695c7085d06ed7dbb34f4e
tree0cdf789ebbbb660755229fcbde4144b690a05e3b
parentb6ca88ab9d7b3e15b6ba541bc581bf018c453537
Clarify the behavior of BIO_gets() a bit more

The API contract is more tight than was previously documented -- the returned
string must be NUL-terminated, and the supplied buffer includes space for
the trailing NUL, so the maximum length that can be read in is reduced.

Clarify that the NUL is not included in the returned length, and fix the
spelling of "NUL-terminated" in a nearby spot.

Adjust punctuation to make a modest improvement to the grammar.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
doc/crypto/BIO_read.pod