From 5aae74d7a6134e3072f8d311d3ce16efd971baef Mon Sep 17 00:00:00 2001
From: yuangongji <82787816@qq.com>
Date: Sat, 21 Sep 2019 23:37:38 +0800
Subject: [PATCH] improve the description of parameter to evbuffer_read()

---
 include/event2/buffer.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/event2/buffer.h b/include/event2/buffer.h
index 1fb30eca..a9afc3c6 100644
--- a/include/event2/buffer.h
+++ b/include/event2/buffer.h
@@ -748,7 +748,8 @@ int evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd,
 
   @param buffer the evbuffer to store the result
   @param fd the file descriptor to read from
-  @param howmuch the number of bytes to be read
+  @param howmuch the number of bytes to be read. If the given number is negative
+  or out of maximum bytes per one read, as many bytes as we can will be read.
   @return the number of bytes read, or -1 if an error occurred
   @see evbuffer_write()
  */
-- 
2.40.0