From 133aa5eb4bae0c274a3f695dec3afc7b16a1fd83 Mon Sep 17 00:00:00 2001
From: Malcolm Tredinnick <malcolm.tredinnick@gmail.com>
Date: Mon, 17 Dec 2007 12:50:06 +0000
Subject: [PATCH] Fixed #6119 -- Documented HttpRequest.get_host(). Thanks,
 PJCrosier.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@6941 bcc190cf-cafb-0310-a4f2-bffc1f526a37
---
 docs/request_response.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/request_response.txt b/docs/request_response.txt
index c8d6423841..e3d794c9ba 100644
--- a/docs/request_response.txt
+++ b/docs/request_response.txt
@@ -156,6 +156,18 @@ Methods
    Returns ``True`` or ``False``, designating whether ``request.GET`` or
    ``request.POST`` has the given key.
 
+``get_host()``
+   **New in Django development version**
+
+   Returns the originating host of the request using information from the
+   ``HTTP_X_FORWARDED_HOST`` and ``HTTP_HOST`` headers (in that order). If
+   they don't provide a value, the method uses a combination of
+   ``SERVER_NAME`` and ``SERVER_PORT`` as detailed in `PEP 333`_.
+
+   .. _PEP 333: http://www.python.org/dev/peps/pep-0333/
+
+   Example: ``"127.0.0.1:8000"``
+
 ``get_full_path()``
    Returns the ``path``, plus an appended query string, if applicable.