[IMP] tools: added disclaimer on detect_ip_addr

bzr revid: odo@openerp.com-20100622154500-lsoxuy0cz1p05lrb

1 files changed, 5 insertions, 0 deletions

diff --git a/bin/tools/misc.py b/bin/tools/misc.py
index 89f3f721f9d..43a283da2a4 100644
--- a/bin/tools/misc.py
+++ b/bin/tools/misc.py
@@ -1159,6 +1159,11 @@ def extract_zip_file(zip_file, outdirectory):
     zf.close()
 
 def detect_ip_addr():
+    """Try a very crude method to figure out a valid external
+       IP or hostname for the current machine. Don't rely on this
+       for binding to an interface, but it could be used as basis
+       for constructing a remote URL to the server.
+    """
     def _detect_ip_addr():
         from array import array
         import socket