Skip to content

Commit

Permalink
docs: link to options ref from configuration; fix link errors in debu…
Browse files Browse the repository at this point in the history
…g_probes
  • Loading branch information
flit committed Jun 12, 2022
1 parent 0b489e7 commit a29d167
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This guide documents how to configure pyOCD.

## Introduction

pyOCD allows you to control many aspects of its behaviour by setting session options. There are
multiple ways to set these options.
pyOCD allows you to control many aspects of its behaviour by setting
[session options]({% link _docs/options.md %}). There are multiple ways to set these options.

- Many of the most commonly used session options have dedicated command line arguments.
- Options can be placed in a YAML config file.
Expand All @@ -24,6 +24,12 @@ The priorities of the different session option sources, from highest to lowest:
4. General options from a config file.
5. _option_defaults_ parameter to constructor. Used only in rare cases.

<div class="alert alert-info">
<p>
The full set of session options is documented in the
<a href="{% link _docs/options.md %}">Session options list</a> reference.
</p>
</div>

## Project directory

Expand Down
6 changes: 3 additions & 3 deletions docs/debug_probes.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ available.

In any case, whether required because the probe doesn't have a default, or to override the default, the target
type can be specified either on the command line with the `-t` / `--target` argument, or by setting the
`target_override` session option (e.g., in a [config file]({% link _docs/configuration.md#config_file %})).
`target_override` session option (e.g., in a [config file]({% link _docs/configuration.md %}#config_file)).

Note that the printed list includes only those probes that pyOCD can actively query for, which currently means
only USB based probes.
Expand Down Expand Up @@ -206,8 +206,8 @@ is strongly recommended. Numerous bugs have been fixed, and new commands added f
- V2J28: Minimum version for multicore target support.
- V2J32/V3J2: Allows access to banked DP registers. Usually not needed.
- V2J32/V3J2: Supports setting the AHB and AXI transfer attributes. See
[`set hnonsec`]({% link _docs/command_reference.md#hnonsec %}) and
[`set hprot`]({% link command_reference.md_docs/#hprot %}).
[`set hnonsec`]({% link _docs/command_reference.md %}#hnonsec) and
[`set hprot`]({% link _docs/command_reference.md %}#hprot).

[STLink firmware updates on www.st.com](https://www.st.com/en/development-tools/stsw-link007.html).

Expand Down

0 comments on commit a29d167

Please sign in to comment.