Rev 3630: Document the difference in get_host_name, per Robert's request. in http://bzr.arbash-meinel.com/branches/bzr/1.7-dev/unicode_hostname

[John Arbash Meinel]

At http://bzr.arbash-meinel.com/branches/bzr/1.7-dev/unicode_hostname

------------------------------------------------------------
revno: 3630
revision-id: john at arbash-meinel.com-20080903195948-24iha6kjan1b0pc9
parent: john at arbash-meinel.com-20080819194410-f1cxgbwx541r8vaq
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: unicode_hostname
timestamp: Wed 2008-09-03 14:59:48 -0500
message:
  Document the difference in get_host_name, per Robert's request.
-------------- next part --------------
=== modified file 'bzrlib/osutils.py'
--- a/bzrlib/osutils.py	2008-08-16 04:00:54 +0000
+++ b/bzrlib/osutils.py	2008-09-03 19:59:48 +0000
@@ -1450,7 +1450,11 @@
 
 
 def get_host_name():
-    """Return the current unicode host name"""
+    """Return the current unicode host name.
+
+    This is meant to be used in place of socket.gethostname() because that
+    behaves inconsistently on different platforms.
+    """
     if sys.platform == "win32":
         import win32utils
         return win32utils.get_host_name()