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.
This commit is contained in:
parent
2db68b600b
commit
223ed1a26b
2
dist/tests/if_lib/README.md
vendored
2
dist/tests/if_lib/README.md
vendored
@ -6,3 +6,5 @@ Introduction
|
|||||||
|
|
||||||
This library provides a Python interface to the test simulator board
|
This library provides a Python interface to the test simulator board
|
||||||
using a serial link.
|
using a serial link.
|
||||||
|
|
||||||
|
*Moving out of RIOT to RIOT-OS/lib_if repo*
|
||||||
|
|||||||
1
dist/tests/if_lib/base_device.py
vendored
1
dist/tests/if_lib/base_device.py
vendored
@ -15,6 +15,7 @@ class BaseDevice:
|
|||||||
"""Instance for devices to connect and untilize drivers."""
|
"""Instance for devices to connect and untilize drivers."""
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
|
logging.warning("deprecated, moving library to RIOT-OS/if_lib")
|
||||||
self._driver = driver_manager.driver_from_config(*args, **kwargs)
|
self._driver = driver_manager.driver_from_config(*args, **kwargs)
|
||||||
|
|
||||||
def close(self):
|
def close(self):
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
*deprecated: BPT is renamed to PHiLIP, more information found [here](https://github.com/MrKevinWeiss/PHiLIP)*
|
||||||
|
|
||||||
How To Run
|
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).
|
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).
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
*deprecated: BPT is renamed to PHiLIP, more information found [here](https://github.com/MrKevinWeiss/PHiLIP)*
|
||||||
|
|
||||||
How To Run
|
How To Run
|
||||||
==========
|
==========
|
||||||
Connect the DUT (device under test) UART6 to the BPT (bluepill tester).
|
Connect the DUT (device under test) UART6 to the BPT (bluepill tester).
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user