From 635b1023a17973f81e4f4a96a8b543a5e1664e8a Mon Sep 17 00:00:00 2001
From: Jan Kiszka <jan.kiszka@siemens.com>
Date: Mon, 12 Jul 2021 07:55:32 +0200
Subject: [PATCH] Declare proxy_config obsolete

Since 7b18e5ec3b27, which was released with 0.19.0, proxy_config has no
effect anymore. No one seems to have missed it, likely because setting
the proxies via the config file was a mistake anyway. The environment
variables are the proper way.

Declare these config entries officially obsolete and warn if they still
hang around in some legacy config. We will drop them from the schema in
one of the next releases.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 docs/command-line.rst | 4 ++--
 docs/userguide.rst    | 8 --------
 kas/includehandler.py | 4 ++++
 3 files changed, 6 insertions(+), 10 deletions(-)

diff --git a/docs/command-line.rst b/docs/command-line.rst
index 86f6b7b..5f3aa18 100644
--- a/docs/command-line.rst
+++ b/docs/command-line.rst
@@ -63,8 +63,8 @@ Environment variables
 | ``SSTATE_DIR``           | the bitbake environment.                         |
 | ``TMPDIR``               |                                                  |
 +--------------------------+--------------------------------------------------+
-| ``http_proxy``           | This overwrites the proxy configuration in the   |
-| ``https_proxy``          | configuration file.                              |
+| ``http_proxy``           | These variables define the proxy configuration   |
+| ``https_proxy``          | bitbake should use.                              |
 | ``ftp_proxy``            |                                                  |
 | ``no_proxy``             |                                                  |
 +--------------------------+--------------------------------------------------+
diff --git a/docs/userguide.rst b/docs/userguide.rst
index e996245..36f2600 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -418,11 +418,3 @@ Configuration reference
   * ``<local-conf-id>``: string [optional]
       A string that is added to the ``local.conf``. It operates in the same way
       as the ``bblayers_conf_header`` entry.
-
-* ``proxy_config``: dict [optional]
-    Defines the proxy configuration bitbake should use. Every entry can be
-    overwritten by the respective environment variables.
-
-  * ``http_proxy``: string [optional]
-  * ``https_proxy``: string [optional]
-  * ``no_proxy``: string [optional]
diff --git a/kas/includehandler.py b/kas/includehandler.py
index 4a1b549..5964a32 100644
--- a/kas/includehandler.py
+++ b/kas/includehandler.py
@@ -93,6 +93,10 @@ def load_config(filename):
                                           __file_version__, version_value),
                                   filename)
 
+    if config.get('proxy_config'):
+        logging.warning('Obsolete ''proxy_config'' detected. '
+                        'This has no effect and will be rejected soon.')
+
     return config