From 35267245948fef5561a921943c1eb118cfb704b0 Mon Sep 17 00:00:00 2001
From: antirez <antirez@gmail.com>
Date: Wed, 2 Nov 2011 16:09:14 +0100
Subject: [PATCH] added a comment to sdsMakeRoomFor() to make it clear what the
 function actually does.

---
 src/sds.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/sds.c b/src/sds.c
index 2104eb36..fc104a4a 100644
--- a/src/sds.c
+++ b/src/sds.c
@@ -101,6 +101,12 @@ void sdsclear(sds s) {
     sh->buf[0] = '\0';
 }
 
+/* Enlarge the free space at the end of the sds string so that the caller
+ * is sure that after calling this function can overwrite up to addlen
+ * bytes after the end of the string, plus one more byte for nul term.
+ * 
+ * Note: this does not change the *size* of the sds string as returned
+ * by sdslen(), but only the free buffer space we have. */
 static sds sdsMakeRoomFor(sds s, size_t addlen) {
     struct sdshdr *sh, *newsh;
     size_t free = sdsavail(s);
-- 
2.45.2