You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/10/18 22:01:43 UTC
[GitHub] [incubator-nuttx] diegoherranz opened a new pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
diegoherranz opened a new pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031
- Add mentions to SWD
- Sony's OpenOCD fork no longer needed since Nuttx support was merged upstream
on http://openocd.zylin.com/#/c/4103/. Recommended to build from source or use
one of the unofficial, more recent builds.
- Amazon link for Olimex adapter was no longer available so removed.
- Reordered and some parts rewritten
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] justinmclean commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
justinmclean commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-712578532
Hi,
> But we are just linking to it. I'm not sure what the issue in question is here? This is not taking the text from the article.
>
Linking to it is fine, just don’t take any text from it.
Thanks,
Justin
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 merged pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 merged pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-712578032
> Hi,
> Does it matter that the author of that wiki page claims a Creative_Commons_Attribution-ShareAlike license? https://en.wikipedia.org/wiki/Wikipedia:Text_of__3.0_Unported_License <https://en.wikipedia.org/wiki/Wikipedia:Text_of__3.0_Unported_License>
> Yes it does see [1]
But we are just linking to it. I'm not sure what the issue in question is here? This is not taking the text from the article.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] justinmclean commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
justinmclean commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-712576768
Hi,
> Does it matter that the author of that wiki page claims a Creative_Commons_Attribution-ShareAlike license?
>
> https://en.wikipedia.org/wiki/Wikipedia:Text_of__3.0_Unported_License <https://en.wikipedia.org/wiki/Wikipedia:Text_of__3.0_Unported_License>
Yes it does see [1]
> Wikipedia is also a registered trademark. Does that matte?
>
As long as you are respectful of the trademark that fine, I wouldn’t;t expect that Wikipedia forbid uses of it trademark use like this.
Thanks,
Justin
1. https://www.apache.org/legal/resolved.html#cc-by
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] diegoherranz commented on a change in pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
diegoherranz commented on a change in pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#discussion_r507531433
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -89,28 +89,31 @@ You can put a bunch of these into a simple script to configure the logging the w
make oldconfig
-JTAG Debugging
---------------
+JTAG/SWD Debugging
+------------------
`JTAG <https://en.wikipedia.org/wiki/JTAG>`_ is a set of standards that specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code, start, stop, step through the program, and
-examine variables and memory.
-
-This guide assumes your board has a JTAG connector, and you have a JTAG hardware debugger like a
-`Segger J-Link <https://www.segger.com/products/debug-probes/j-link/>`_ or `OpenOCD <http://openocd.org/doc-release/html/index.html>`_.
+examine variables and memory. `SWD <https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards>`_ is an
+Arm-specific, alternative 2-pin electrical interface that uses the same protocol and can be used too.
Review comment:
I can rewrite "alternative 2-pin electrical interface that uses the same protocol" which was copy-pasted from there. I didn't think of if given it was just a short sentence. Would that be better?
> Wikipedia is also a registered trademark. Does that matte?
In terms of the trademark, we only include the word Wikipedia in the actual link to its website. I don't know about legal, stuff but I would expect that to be OK? Otherwise it would be difficult to link anything. Does anyone one for certain?
Sony must be a trademark too. Should that be mentioned somewhere?
Thanks.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] justinmclean commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
justinmclean commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-712578294
Hi,
See [1] (this would be fine) and for use of Sony see [2] (which seem easy to comply with).
Thanks,
Justin
1. https://foundation.wikimedia.org/wiki/Trademark_policy <https://foundation.wikimedia.org/wiki/Trademark_policy>
2. https://www.sonycreativesoftware.com/corporate/copyright <https://www.sonycreativesoftware.com/corporate/copyright>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-713323616
So, the copyright concern get resolved, let's merge it!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on a change in pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
patacongo commented on a change in pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#discussion_r507265234
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -89,28 +89,31 @@ You can put a bunch of these into a simple script to configure the logging the w
make oldconfig
-JTAG Debugging
---------------
+JTAG/SWD Debugging
+------------------
`JTAG <https://en.wikipedia.org/wiki/JTAG>`_ is a set of standards that specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code, start, stop, step through the program, and
-examine variables and memory.
-
-This guide assumes your board has a JTAG connector, and you have a JTAG hardware debugger like a
-`Segger J-Link <https://www.segger.com/products/debug-probes/j-link/>`_ or `OpenOCD <http://openocd.org/doc-release/html/index.html>`_.
+examine variables and memory. `SWD <https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards>`_ is an
+Arm-specific, alternative 2-pin electrical interface that uses the same protocol and can be used too.
Review comment:
Does it matter that the author of that wiki page claims a Creative_Commons_Attribution-ShareAlike license?
https://en.wikipedia.org/wiki/Wikipedia:Text_of__3.0_Unported_License
Wikipedia is also a registered trademark. Does that matte?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] diegoherranz commented on pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
diegoherranz commented on pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#issuecomment-713367105
I was just about to rewrite the SWD sentence so that it's not a copy-paste from the Wikipedia. I'll do that on another pull request.
Thanks.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on a change in pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on a change in pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#discussion_r507250392
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -89,28 +89,31 @@ You can put a bunch of these into a simple script to configure the logging the w
make oldconfig
-JTAG Debugging
---------------
+JTAG/SWD Debugging
+------------------
`JTAG <https://en.wikipedia.org/wiki/JTAG>`_ is a set of standards that specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code, start, stop, step through the program, and
-examine variables and memory.
-
-This guide assumes your board has a JTAG connector, and you have a JTAG hardware debugger like a
-`Segger J-Link <https://www.segger.com/products/debug-probes/j-link/>`_ or `OpenOCD <http://openocd.org/doc-release/html/index.html>`_.
+examine variables and memory. `SWD <https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards>`_ is an
+Arm-specific, alternative 2-pin electrical interface that uses the same protocol and can be used too.
The NuttX operating system uses `threads <https://en.wikipedia.org/wiki/Thread_(computing)>`_, so you need a
thread-aware debugger to do more than load code, start, and stop it. A thread-aware debugger will allow you to switch
threads to the one that is running the code you're interested in, for instance your application, or an operating system
-network thread. So far, OpenOCD is the only supported NuttX thread-aware debugger.
-
-You will need an OpenOCD-compatible hardware adapter, ideally a fast one (USB 2.0 High Speed). This guide assumes you
-are using the `Olimex ARM USB TINY H <https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/>`_.
-(`Olimex ARM USB TINY H on Amazon <https://smile.amazon.com/Olimex-ARM-USB-TINY-H-Arm-Jtag/dp/B009UED630/>`_.) Other
-adapters may work, follow the OpenOCD instructions and the instructions that came with your adapter.
-
-You'll need to use the `Sony fork of OpenOCD <https://github.com/sony/openocd-nuttx>`_. Download and install it
-according to the OpenOCD instructions.
+network thread. So far, `OpenOCD <http://openocd.org/>`_ is the only supported NuttX thread-aware debugger.
+
+.. note::
+ OpenOCD hasn't announced a stable release for a few years but the development remains active. You'll need to use a
+ version of OpenOCD recent enough so that it includes Nuttx support as `contributed by Sony upstream
Review comment:
Just one minor nit: Please could you capitalize NuttX with a capital X for consistency? Thanks
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] diegoherranz commented on a change in pull request #2031: Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
Posted by GitBox <gi...@apache.org>.
diegoherranz commented on a change in pull request #2031:
URL: https://github.com/apache/incubator-nuttx/pull/2031#discussion_r507528153
##########
File path: Documentation/quickstart/debugging.rst
##########
@@ -89,28 +89,31 @@ You can put a bunch of these into a simple script to configure the logging the w
make oldconfig
-JTAG Debugging
---------------
+JTAG/SWD Debugging
+------------------
`JTAG <https://en.wikipedia.org/wiki/JTAG>`_ is a set of standards that specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code, start, stop, step through the program, and
-examine variables and memory.
-
-This guide assumes your board has a JTAG connector, and you have a JTAG hardware debugger like a
-`Segger J-Link <https://www.segger.com/products/debug-probes/j-link/>`_ or `OpenOCD <http://openocd.org/doc-release/html/index.html>`_.
+examine variables and memory. `SWD <https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards>`_ is an
+Arm-specific, alternative 2-pin electrical interface that uses the same protocol and can be used too.
The NuttX operating system uses `threads <https://en.wikipedia.org/wiki/Thread_(computing)>`_, so you need a
thread-aware debugger to do more than load code, start, and stop it. A thread-aware debugger will allow you to switch
threads to the one that is running the code you're interested in, for instance your application, or an operating system
-network thread. So far, OpenOCD is the only supported NuttX thread-aware debugger.
-
-You will need an OpenOCD-compatible hardware adapter, ideally a fast one (USB 2.0 High Speed). This guide assumes you
-are using the `Olimex ARM USB TINY H <https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/>`_.
-(`Olimex ARM USB TINY H on Amazon <https://smile.amazon.com/Olimex-ARM-USB-TINY-H-Arm-Jtag/dp/B009UED630/>`_.) Other
-adapters may work, follow the OpenOCD instructions and the instructions that came with your adapter.
-
-You'll need to use the `Sony fork of OpenOCD <https://github.com/sony/openocd-nuttx>`_. Download and install it
-according to the OpenOCD instructions.
+network thread. So far, `OpenOCD <http://openocd.org/>`_ is the only supported NuttX thread-aware debugger.
+
+.. note::
+ OpenOCD hasn't announced a stable release for a few years but the development remains active. You'll need to use a
+ version of OpenOCD recent enough so that it includes Nuttx support as `contributed by Sony upstream
Review comment:
Consistency is important. Fixed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org