Merge pull request #397 from eblot/dev/ebl/uprev_doc

doc: update requirements and dependencies
eblot · Nov 23, 2024 · 16398f3 · 16398f3
2 parents c228f72 + 556ce51
commit 16398f3
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 17 deletions.
diff --git a/pyftdi/doc/defs.rst b/pyftdi/doc/defs.rst
@@ -10,6 +10,7 @@
 .. _FTDI_Recovery: https://www.ftdichip.com/Support/Documents/AppNotes/AN_136%20Hi%20Speed%20Mini%20Module%20EEPROM%20Disaster%20Recovery.pdf
 .. _PyFtdi: https://www.github.com/eblot/pyftdi
 .. _PyFtdiTools: https://github.com/eblot/pyftdi/tree/master/pyftdi/bin
+.. _PyJtagTools: https://www.github.com/eblot/pyjtagtools
 .. _FTDI: https://www.ftdichip.com/
 .. _PyUSB: https://pyusb.github.io/pyusb/
 .. _Python: https://www.python.org/
@@ -29,7 +30,7 @@
 .. _PEP_498: https://www.python.org/dev/peps/pep-0498
 .. _PEP_526: https://www.python.org/dev/peps/pep-0526
 .. _ruamel.yaml: https://pypi.org/project/ruamel.yaml
-
+.. _PyFtdiWin: https://github.com/mariusgreuel/pyftdiwin
 
 .. Restructured Text levels
 

diff --git a/pyftdi/doc/features.rst b/pyftdi/doc/features.rst
@@ -84,6 +84,9 @@ JTAG API is limited to low-level access. It is not intented to be used for
 any flashing or debugging purpose, but may be used as a base to perform SoC
 tests and boundary scans.
 
+It requires the PyJtagTools_ Python module which integrates a JTAG engine, while
+PyFtdi_ implements the FTDI JTAG backend.
+
 EEPROM
 ``````
 

diff --git a/pyftdi/doc/requirements.rst b/pyftdi/doc/requirements.rst
@@ -5,28 +5,15 @@ Requirements
 
 Python_ 3.9 or above is required.
 
-* PyFtdi *v0.55* is the last PyFtdi version to support Python 3.8.
-
-
-  * Python 3.7 has reached end-of-life on June 27rd, 2023.
-
-* PyFtdi *v0.53* is the last PyFtdi version to support Python 3.6.
-
-  * Python 3.6 has reached end-of-life on December 23rd, 2021.
-
-* PyFtdi *v0.52* is the last PyFtdi version to support Python 3.5.
-
-  * Python 3.5 has reached end-of-life on September 5th, 2020.
-
 PyFtdi_ relies on PyUSB_, which itself depends on one of the following native
 libraries:
 
 * libusb_, currently tested with 1.0.23
 
-PyFtdi_ does not depend on any other native library, and only uses standard
-Python modules along with PyUSB_ and pyserial_.
+PyFtdi_ does not depend on any other native library. It only uses standard
+Python modules, and PyUSB_, pyserial_ and PyJtagTools_.
 
-PyFtdi_ is beeing tested with PyUSB_ 1.1.0.
+PyFtdi_ is being tested with PyUSB_ 1.2.1.
 
 Development
 ~~~~~~~~~~~
@@ -39,6 +26,8 @@ supported platforms. However, M$ Windows is a seamless source of issues and is
 not officially supported, although users have reported successful installation
 with Windows 7 for example. Your mileage may vary.
 
+A fork of PyFtdi which relies on the official FTDI D2XX Windows library might be
+a better solution for Windows users, please check out PyFtdiWin_.
 
 API breaks
 ~~~~~~~~~~
@@ -52,3 +41,22 @@ new PyFtdi releases. PyFtdi versions up to *v0.39.9* keep a stable API
 with *v0.22+* series.
 
 See the *Major Changes* section for details about potential API breaks.
+
+Legacy Python support
+~~~~~~~~~~~~~~~~~~~~~
+
+* PyFtdi *v0.55* is the last PyFtdi version to support Python 3.8.
+
+  * Python 3.8 has reached end-of-life on October 7th, 2024.
+
+* PyFtdi *v0.54* is the last PyFtdi version to support Python 3.7.
+
+  * Python 3.7 has reached end-of-life on June 27rd, 2023.
+
+* PyFtdi *v0.53* is the last PyFtdi version to support Python 3.6.
+
+  * Python 3.6 has reached end-of-life on December 23rd, 2021.
+
+* PyFtdi *v0.52* is the last PyFtdi version to support Python 3.5.
+
+  * Python 3.5 has reached end-of-life on September 5th, 2020.