From 3b8c54429b4da595f72bc6c2738bd03ba03ab80c Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Thu, 30 Aug 2012 09:26:26 +0200
Subject: Add warning about 'host' filter

---
 lib/diameter/doc/src/diameter.xml | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

(limited to 'lib/diameter')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index fdd18929df..0bfbf62cd3 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -463,6 +463,10 @@ specified list.</p>
 
 </taglist>
 
+<p>
+An invalid filter is equivalent to <c>{any,[]}</c>, a filter
+that matches no peer.</p>
+
 <note>
 <p>
 The <c>host</c> and <c>realm</c> filters examine the
@@ -473,13 +477,18 @@ the message contains at most one of each AVP.
 If this is not the case then the <c>{host|realm, <seealso
 marker="diameter_dict#DATA_TYPES">DiameterIdentity()</seealso>}</c>
 filters must be used to achieve the desired result.
-An empty host/realm (which should not be typical)
-is equivalent to an unspecified one for the purposes of filtering.</p>
+An empty <c><seealso
+marker="diameter_dict#DATA_TYPES">DiameterIdentity()</seealso></c>
+(which should not be typical)
+matches all hosts/realms for the purposes of filtering.</p>
 </note>
 
+<warning>
 <p>
-An invalid filter is equivalent to <c>{any,[]}</c>, a filter
-that matches no peer.</p>
+A <c>host</c> filter is not typically desirable when setting
+Destination-Host since it will remove peer agents from the
+candidates list.</p>
+</warning>
 
 <marker id="service_event"/>
 </item>
-- 
cgit v1.2.3