From: Amos Jeffries <squid3@treenet.co.nz>
Date: Sat, 28 Jan 2017 03:36:52 +0000 (+1300)
Subject: Prep for 3.5.24
X-Git-Tag: SQUID_4_0_18~4
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8f42f451f485df2a2cd65157aa87e9b0ec8c1662;p=thirdparty%2Fsquid.git

Prep for 3.5.24
---

diff --git a/ChangeLog b/ChangeLog
index 262c1e34c9..47fed9657d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -255,6 +255,17 @@ Changes to squid-4.0.1 (14 Oct 2015):
 	- ... and many documentation changes
 	- ... and much code cleanup and polishing
 
+Changes to squid-3.5.24 (28 Jan 2017):
+
+	- Regression Bug 3940: Make 'cache deny' do what is documented
+	- TLS: Fix SSLv2 records bumping despite a matching step2 peek rule
+	- TLS: Mitigate DoS attacks that use client-initiated SSL/TLS renegotiation
+	- Fix "Source and destination overlap in memcpy" Valgrind errors
+	- Reduce crashes due to unexpected ClientHttpRequest termination
+	- Update External ACL helpers error handling and caching
+	- Detect HTTP header ACL issues
+	- ... and some documentation fixes
+
 Changes to squid-3.5.23 (16 Dec 2016):
 
 	- Bug 4627: fix generate-host-certificates and dynamic_cert_mem_cache_size docs
diff --git a/doc/release-notes/release-3.5.sgml b/doc/release-notes/release-3.5.sgml
index 92e0cfd75d..7b8fa846ef 100644
--- a/doc/release-notes/release-3.5.sgml
+++ b/doc/release-notes/release-3.5.sgml
@@ -1,6 +1,6 @@
 <!doctype linuxdoc system>
 <article>
-<title>Squid 3.5.23 release notes</title>
+<title>Squid 3.5.24 release notes</title>
 <author>Squid Developers</author>
 
 <abstract>
@@ -13,7 +13,7 @@ for Applied Network Research and members of the Web Caching community.
 
 <sect>Notice
 <p>
-The Squid Team are pleased to announce the release of Squid-3.5.23.
+The Squid Team are pleased to announce the release of Squid-3.5.24.
 
 This new release is available for download from <url url="http://www.squid-cache.org/Versions/v3/3.5/"> or the
  <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
diff --git a/src/mem/Pool.h b/src/mem/Pool.h
index 51c7c8ddc2..71790f72ec 100644
--- a/src/mem/Pool.h
+++ b/src/mem/Pool.h
@@ -321,13 +321,14 @@ struct _MemPoolGlobalStats {
 };
 
 /// \ingroup MemPoolsAPI
+/// Creates a named MemPool of elements with the given size
 #define memPoolCreate MemPools::GetInstance().create
 
 /* Allocator API */
 /**
  \ingroup MemPoolsAPI
  * Initialise iteration through all of the pools.
- \retval  Iterator for use by memPoolIterateNext() and memPoolIterateDone()
+ * \returns Iterator for use by memPoolIterateNext() and memPoolIterateDone()
  */
 extern MemPoolIterator * memPoolIterate(void);
 
@@ -347,10 +348,12 @@ extern void memPoolIterateDone(MemPoolIterator ** iter);
  \ingroup MemPoolsAPI
  \todo Stats API - not sured how to refactor yet
  *
- * Fills MemPoolGlobalStats with statistical data about overall
+ * Fills a MemPoolGlobalStats with statistical data about overall
  * usage for all pools.
  *
- \retval  Number of pools that have at least one object in use.
+ * \param stats   Object to be filled with statistical data.
+ *
+ * \return Number of pools that have at least one object in use.
  *        Ie. number of dirty pools.
  */
 extern int memPoolGetGlobalStats(MemPoolGlobalStats * stats);
diff --git a/src/mem/forward.h b/src/mem/forward.h
index 9d761e7f8a..3bc54466f2 100644
--- a/src/mem/forward.h
+++ b/src/mem/forward.h
@@ -50,14 +50,17 @@ typedef enum {
     MEM_MAX
 } mem_type;
 
+/// Main cleanup handler.
 void memClean(void);
 void memInitModule(void);
 void memCleanModule(void);
 void memConfigure(void);
+/// Allocate one element from the typed pool
 void *memAllocate(mem_type);
 void *memAllocString(size_t net_size, size_t * gross_size);
 void *memAllocBuf(size_t net_size, size_t * gross_size);
 void *memReallocBuf(void *buf, size_t net_size, size_t * gross_size);
+/// Free a element allocated by memAllocate()
 void memFree(void *, int type);
 void memFreeString(size_t size, void *);
 void memFreeBuf(size_t size, void *);