Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section #2031

Merged
merged 2 commits into from Oct 21, 2020

Conversation

diegoherranz
Copy link
Contributor

  • 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

- 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 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@justinmclean
Copy link
Member

justinmclean commented Oct 20, 2020 via email

@btashton
Copy link
Contributor

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.

@justinmclean
Copy link
Member

justinmclean commented Oct 20, 2020 via email

@justinmclean
Copy link
Member

justinmclean commented Oct 20, 2020 via email

@xiaoxiang781216
Copy link
Contributor

So, the copyright concern get resolved, let's merge it!

@xiaoxiang781216 xiaoxiang781216 merged commit 345f2a7 into apache:master Oct 21, 2020
@diegoherranz
Copy link
Contributor Author

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.

@diegoherranz diegoherranz deleted the doc_openocd branch October 21, 2020 07:25
diegoherranz added a commit to diegoherranz/incubator-nuttx that referenced this pull request Oct 21, 2020
Original content rather than copy-paste from Wikipedia.
Discussed on apache#2031
xiaoxiang781216 pushed a commit that referenced this pull request Oct 21, 2020
Original content rather than copy-paste from Wikipedia.
Discussed on #2031
@btashton btashton added this to To-Add in Release Notes - 10.1.0 Apr 12, 2021
@jerpelea jerpelea moved this from To-Add to Minor in Release Notes - 10.1.0 Apr 12, 2021
@jerpelea jerpelea moved this from Minor to DOCS in Release Notes - 10.1.0 Apr 16, 2021
@jerpelea jerpelea moved this from DOCS to Added in Release Notes - 10.1.0 Apr 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants