[Doc] Update ST-Link doc following debugging chapter introduction #14747
Conversation
|
All checks are passing now. Review history of this comment for details about previous failed status. |
erwango
force-pushed
the
doc_probes_stlink
branch
from
2f55bed
to
78b8bce
Compare
Codecov Report
@@ Coverage Diff @@
## master #14747 +/- ##
==========================================
- Coverage 52.93% 52.92% -0.02%
==========================================
Files 309 309
Lines 45268 45268
Branches 10451 10451
==========================================
- Hits 23961 23956 -5
- Misses 16542 16544 +2
- Partials 4765 4768 +3
Continue to review full report at Codecov.
|
Well, can you approve then ? ;-) |
| @@ -88,3 +97,6 @@ Check if your SoC is listed in `pyOCD Supported Devices`_. | |||
|
|
|||
| .. _pyOCD Supported Devices: | |||
| https://github.com/mbedmicro/pyOCD/tree/master/pyocd/target/builtin | |||
|
|
|||
| .. _OpenOCD Windows: | |||
| http://gnutoolchains.com/arm-eabi/openocd/ | |||
There was a problem hiding this comment.
Why here? What about the GNU MCU Eclipse mentioned in the "Getting OpenOCD" page?
There was a problem hiding this comment.
Seems this may not be the best way to get up to date openocd binaries (for windows at least). For windows, it redirects to http://www.freddiechopin.info/en/download/category/4-openocd with latest build having: 'build date: 2017-01-23'. (which is older than the oldest binary in http://gnutoolchains.com/arm-eabi/openocd/)
doc/guides/debugging/index.rst
Outdated
| @@ -8,3 +8,4 @@ Debugging | |||
|
|
|||
| host-tools.rst | |||
| probes.rst | |||
| stlink-v21.rst | |||
There was a problem hiding this comment.
Is this separate page really still necessary?
There was a problem hiding this comment.
Information provided in this page is not available anywhere else so it's worth keeping, IMHO. This being said I'm open to alternative locations.
There was a problem hiding this comment.
I think it can be worked into the debug probe page
erwango
force-pushed
the
doc_probes_stlink
branch
from
78b8bce
to
e63ae9a
Compare
erwango
force-pushed
the
doc_probes_stlink
branch
from
e63ae9a
to
764b677
Compare
doc/guides/debugging/probes.rst
Outdated
| ------------- | ||
|
|
||
| Openocd is available by default on ST-Link and configure as default flash and | ||
| debug tool, flash and debug could be done as follows: |
There was a problem hiding this comment.
Suggest rewording a little:
OpenOCD is available by default on ST-Link and configured as the default flash and
debug tool. Flash and debug can be done as follows:
doc/guides/debugging/probes.rst
Outdated
| Flash and debug with ST-Link | ||
| ============================ | ||
|
|
||
| Using Openocd |
erwango
force-pushed
the
doc_probes_stlink
branch
from
764b677
to
696ece2
Compare
Add ST-Link chapter in probes page and reference in host-tool openocd section. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
Add a note to mention how to get openocd working on windows. This is taken from stlink-v21.rst file before its reformatting. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
erwango
force-pushed
the
doc_probes_stlink
branch
from
696ece2
to
b5e4185
Compare
Following #14000, a debugging section is introduced to describe properly debug probes and matching host tools. In this context it makes sense to remove existing doc/guides/tools/stlink-v21.rst and dispatch information in newly created files.
Remains some specific information, dedicated to OpenOcd/JLink usage with STLink which hardly fits in host-tool.rst or probes.rst, so create a new file stlink-v21.rst in debugging section. I'm open to other option to have that allow to have this information centralized in another place.
Based on #14000.