From 635c1614be33f0da705af8f3bd8c874315524a71 Mon Sep 17 00:00:00 2001
From: Amos Jeffries <yadij@users.noreply.github.com>
Date: Fri, 7 Sep 2018 16:11:33 +0000
Subject: [PATCH] Bug 4691: balance_on_multiple_ip config option docs (#273)

Add missing balance_on_multiple_ip removal documentation
after the active code was removed by 3.2 TCP connection
server selection changes.
---
 doc/release-notes/release-3.2.sgml |  4 ++++
 src/SquidConfig.h                  |  1 -
 src/cf.data.pre                    | 22 ++++++----------------
 3 files changed, 10 insertions(+), 17 deletions(-)

diff --git a/doc/release-notes/release-3.2.sgml b/doc/release-notes/release-3.2.sgml
index 1359e5bb1b..d09eb1453e 100644
--- a/doc/release-notes/release-3.2.sgml
+++ b/doc/release-notes/release-3.2.sgml
@@ -744,6 +744,10 @@ This section gives a thorough account of those changes in three categories:
 <sect1>Removed tags<label id="removedtags">
 <p>
 <descrip>
+	<tag>balance_on_multiple_ip</tag>
+	<p>Obsolete. The behaviour controlled by this directive is no longer possible
+	   with DNS parallel lookup and connection features (aka 'Happy Eyeballs').
+
 	<tag>chunked_request_body_max_size</tag>
 	<p>Obsolete. Squid is now HTTP/1.1 with support for streaming chunked encoded requests.
 
diff --git a/src/SquidConfig.h b/src/SquidConfig.h
index d99dd62941..fad98154d2 100644
--- a/src/SquidConfig.h
+++ b/src/SquidConfig.h
@@ -315,7 +315,6 @@ public:
         int surrogate_is_remote;
         int request_entities;
         int detect_broken_server_pconns;
-        int balance_on_multiple_ip;
         int relaxed_header_parser;
         int check_hostnames;
         int allow_underscore;
diff --git a/src/cf.data.pre b/src/cf.data.pre
index 6255d302dc..070b7f068b 100644
--- a/src/cf.data.pre
+++ b/src/cf.data.pre
@@ -252,6 +252,12 @@ DOC_START
 DOC_END
 
 # Options Removed in 3.2
+NAME: balance_on_multiple_ip
+TYPE: obsolete
+DOC_START
+	Remove this line. Squid performs a 'Happy Eyeballs' algorithm, this multiple-IP algorithm is not longer relevant.
+DOC_END
+
 NAME: chunked_request_body_max_size
 TYPE: obsolete
 DOC_START
@@ -10188,22 +10194,6 @@ DOC_START
 	get an error saying that Squid can not open the port.
 DOC_END
 
-NAME: balance_on_multiple_ip
-TYPE: onoff
-LOC: Config.onoff.balance_on_multiple_ip
-DEFAULT: off
-DOC_START
-	Modern IP resolvers in squid sort lookup results by preferred access.
-	By default squid will use these IP in order and only rotates to
-	the next listed when the most preffered fails.
-
-	Some load balancing servers based on round robin DNS have been
-	found not to preserve user session state across requests
-	to different IP addresses.
-
-	Enabling this directive Squid rotates IP's per request.
-DOC_END
-
 NAME: pipeline_prefetch
 TYPE: pipelinePrefetch
 LOC: Config.pipeline_max_prefetch
-- 
2.39.5