From 223ed1a26b70dc0bce6d0b17b43ff20906127ffb Mon Sep 17 00:00:00 2001 From: MrKevinWeiss Date: Fri, 24 Aug 2018 15:59:34 +0200 Subject: [PATCH] doc: Add deprecation warnings for new repos This PR add deprication warning to notify anyone using the if_lib files that it is being removed from RIOT repo and making it's own repo (RIOT-OS/lib_if). This is intended to help wil modularization since it is not only being used within RIOT but in other areas as well. README files are updated to indicate the change and if the if_lib is used it will throw a warning indicating the deprecation. --- dist/tests/if_lib/README.md | 2 ++ dist/tests/if_lib/base_device.py | 1 + tests/periph_i2c/tests/README.md | 2 ++ tests/periph_uart/tests/README.md | 2 ++ 4 files changed, 7 insertions(+) diff --git a/dist/tests/if_lib/README.md b/dist/tests/if_lib/README.md index 1fd649fb46..9c396fa6fb 100644 --- a/dist/tests/if_lib/README.md +++ b/dist/tests/if_lib/README.md @@ -6,3 +6,5 @@ Introduction This library provides a Python interface to the test simulator board using a serial link. + +*Moving out of RIOT to RIOT-OS/lib_if repo* diff --git a/dist/tests/if_lib/base_device.py b/dist/tests/if_lib/base_device.py index c146805f66..6dc92974b5 100644 --- a/dist/tests/if_lib/base_device.py +++ b/dist/tests/if_lib/base_device.py @@ -15,6 +15,7 @@ class BaseDevice: """Instance for devices to connect and untilize drivers.""" def __init__(self, *args, **kwargs): + logging.warning("deprecated, moving library to RIOT-OS/if_lib") self._driver = driver_manager.driver_from_config(*args, **kwargs) def close(self): diff --git a/tests/periph_i2c/tests/README.md b/tests/periph_i2c/tests/README.md index 2e8e1cc4e8..1b0d4ed762 100644 --- a/tests/periph_i2c/tests/README.md +++ b/tests/periph_i2c/tests/README.md @@ -1,3 +1,5 @@ +*deprecated: BPT is renamed to PHiLIP, more information found [here](https://github.com/MrKevinWeiss/PHiLIP)* + How To Run ========== Connect the DUT (device under test) I2C0 to the BPT (bluepill tester). Information for BPT setup can be found [here](https://github.com/MrKevinWeiss/Testing). diff --git a/tests/periph_uart/tests/README.md b/tests/periph_uart/tests/README.md index 6e5d655ff5..351bc35e1a 100644 --- a/tests/periph_uart/tests/README.md +++ b/tests/periph_uart/tests/README.md @@ -1,3 +1,5 @@ +*deprecated: BPT is renamed to PHiLIP, more information found [here](https://github.com/MrKevinWeiss/PHiLIP)* + How To Run ========== Connect the DUT (device under test) UART6 to the BPT (bluepill tester).