From: Scott Rifenbark <srifenbark@gmail.com>
Date: Fri, 1 Apr 2016 18:15:28 +0000 (-0700)
Subject: ref-manual: Updated verbiage on proxy handling
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=763ae4e191e09c60dd35faf569f56781515273ba;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

ref-manual: Updated verbiage on proxy handling

Fixes [YOCTO #9313]

Update the DL_DIR variable description to add a cross-reference
to the wiki page that talks about working behind a firewall.

Updated the 14.12 FAQ entry with new information about working
behind the firewall.

(From yocto-docs rev: 056e6881951023e62a7363ba60fe73cd6d2932b6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---

diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index 3137639d9a2..d2e4e8eb1b9 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -280,7 +280,7 @@
 
     <qandaentry>
         <question>
-            <para>
+            <para id='i-am-behind-a-firewall-and-need-to-use-a-proxy-server'>
                 I'm behind a firewall and need to use a proxy server. How do I do that?
             </para>
         </question>
@@ -288,24 +288,34 @@
             <para>
                 Most source fetching by the OpenEmbedded build system is done
                 by <filename>wget</filename> and you therefore need to specify
-                the proxy settings in a <filename>.wgetrc</filename> file
-                in your home directory.
-                Following are some example settings for different proxy types:
+                the proxy settings in a <filename>.wgetrc</filename> file,
+                which can be in your home directory if you are a single user
+                or can be in <filename>/usr/local/etc/wgetrc</filename> as
+                a global user file.
+            </para>
+
+            <para>
+                Following is the applicable code for setting various proxy
+                types in the <filename>.wgetrc</filename> file.
+                By default, these settings are disabled with comments.
+                To use them, remove the comments:
                 <literallayout class='monospaced'>
-     Http/FTP proxy:
-        https_proxy = http://proxy.yoyodyne.com:18023/
-        http_proxy = http://proxy.yoyodyne.com:18023/
-        ftp_proxy = http://proxy.yoyodyne.com:18023/
-
-     socks proxy:
-        export SOCKS_SERVER=`<replaceable>server</replaceable>:<replaceable>port</replaceable>`
-        unset http_proxy
-        unset https_proxy
-        unset ftp_proxy
+     # You can set the default proxies for Wget to use for http, https, and ftp.
+     # They will override the value in the environment.
+     #https_proxy = http://proxy.yoyodyne.com:18023/
+     #http_proxy = http://proxy.yoyodyne.com:18023/
+     #ftp_proxy = http://proxy.yoyodyne.com:18023/
+
+     # If you do not want to use proxy at all, set this to off.
+     #use_proxy = on
                 </literallayout>
                 The Yocto Project also includes a
-                <filename>site.conf.sample</filename> file that shows how to
-                configure CVS and Git proxy servers if needed.
+                <filename>meta-poky/conf/site.conf.sample</filename> file that
+                shows how to configure CVS and Git proxy servers if needed.
+                For more information on setting up various proxy types and
+                configuring proxy servers, see the
+                "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>"
+                Wiki page.
             </para>
         </answer>
     </qandaentry>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 45015a40960..fa652e57a13 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3415,6 +3415,9 @@
                     see this specific question in the
                     "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>"
                     chapter.
+                    You can also refer to the
+                    "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>"
+                    Wiki page.
                 </para>
             </glossdef>
         </glossentry>