From 1af462ff66b69d248f4b9144bb83a27c35370371 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Wed, 16 Mar 2016 22:17:14 +0200 Subject: [PATCH] Fix broken "warning" block for Teensy platform --- docs/platforms/atmelavr.rst | 5 +++-- docs/platforms/atmelsam.rst | 5 +++-- docs/platforms/espressif.rst | 5 +++-- docs/platforms/freescalekinetis.rst | 5 +++-- docs/platforms/nordicnrf51.rst | 5 +++-- docs/platforms/nxplpc.rst | 5 +++-- docs/platforms/siliconlabsefm32.rst | 5 +++-- docs/platforms/ststm32.rst | 5 +++-- docs/platforms/teensy.rst | 8 ++++++-- docs/platforms/timsp430.rst | 5 +++-- docs/platforms/titiva.rst | 5 +++-- scripts/docspregen.py | 22 ++++++++++++++++------ 12 files changed, 52 insertions(+), 28 deletions(-) diff --git a/docs/platforms/atmelavr.rst b/docs/platforms/atmelavr.rst index 780aae4d..677b5393 100644 --- a/docs/platforms/atmelavr.rst +++ b/docs/platforms/atmelavr.rst @@ -44,8 +44,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/atmelsam.rst b/docs/platforms/atmelsam.rst index 21fc3d9b..e511b00b 100644 --- a/docs/platforms/atmelsam.rst +++ b/docs/platforms/atmelsam.rst @@ -50,8 +50,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/espressif.rst b/docs/platforms/espressif.rst index 2a3cca1d..8a2b3258 100644 --- a/docs/platforms/espressif.rst +++ b/docs/platforms/espressif.rst @@ -50,8 +50,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/freescalekinetis.rst b/docs/platforms/freescalekinetis.rst index f30ba372..0e26057c 100644 --- a/docs/platforms/freescalekinetis.rst +++ b/docs/platforms/freescalekinetis.rst @@ -38,8 +38,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/nordicnrf51.rst b/docs/platforms/nordicnrf51.rst index c8b26477..8054ac9a 100644 --- a/docs/platforms/nordicnrf51.rst +++ b/docs/platforms/nordicnrf51.rst @@ -44,8 +44,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/nxplpc.rst b/docs/platforms/nxplpc.rst index c751439e..129213df 100644 --- a/docs/platforms/nxplpc.rst +++ b/docs/platforms/nxplpc.rst @@ -38,8 +38,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/siliconlabsefm32.rst b/docs/platforms/siliconlabsefm32.rst index 13b3055d..11929989 100644 --- a/docs/platforms/siliconlabsefm32.rst +++ b/docs/platforms/siliconlabsefm32.rst @@ -38,8 +38,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/ststm32.rst b/docs/platforms/ststm32.rst index 6e2bca58..a97a15ec 100644 --- a/docs/platforms/ststm32.rst +++ b/docs/platforms/ststm32.rst @@ -53,8 +53,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/teensy.rst b/docs/platforms/teensy.rst index bfc21144..a536fe26 100644 --- a/docs/platforms/teensy.rst +++ b/docs/platforms/teensy.rst @@ -50,9 +50,13 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + **Windows Users:** Teensy programming uses only Windows built-in HID + drivers. When Teensy is programmed to act as a USB Serial device, + Windows XP, Vista, 7 and 8 require `this serial driver + `_ + is needed to access the COM port your program uses. No special driver + installation is necessary on Windows 10. Frameworks diff --git a/docs/platforms/timsp430.rst b/docs/platforms/timsp430.rst index b9653c03..25972285 100644 --- a/docs/platforms/timsp430.rst +++ b/docs/platforms/timsp430.rst @@ -44,8 +44,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/docs/platforms/titiva.rst b/docs/platforms/titiva.rst index ce2514a5..3cc10277 100644 --- a/docs/platforms/titiva.rst +++ b/docs/platforms/titiva.rst @@ -47,8 +47,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer + + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer diff --git a/scripts/docspregen.py b/scripts/docspregen.py index a899fdbd..61d8835e 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -77,7 +77,7 @@ def generate_boards(boards): return "\n".join(lines + [""]) -def generate_packages(packages, is_embedded): +def generate_packages(platform, packages, is_embedded): if not packages: return allpackages = get_packages() @@ -108,12 +108,22 @@ Packages .. warning:: **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). - - **Windows Users:** Please check that you have correctly installed USB driver - from board manufacturer +""") + if platform == "teensy": + lines.append(""" + **Windows Users:** Teensy programming uses only Windows built-in HID + drivers. When Teensy is programmed to act as a USB Serial device, + Windows XP, Vista, 7 and 8 require `this serial driver + `_ + is needed to access the COM port your program uses. No special driver + installation is necessary on Windows 10. +""") + else: + lines.append(""" + **Windows Users:** Please check that you have correctly installed USB + driver from board manufacturer """) - return "\n".join(lines) @@ -151,7 +161,7 @@ For more detailed information please visit `vendor site <%s>`_.""" % # # Packages # - _packages_content = generate_packages(p.get_packages(), p.is_embedded()) + _packages_content = generate_packages(name, p.get_packages(), p.is_embedded()) if _packages_content: lines.append(_packages_content)