Update documentation

Author: github-actions

configure.html

@@ -167,6 +167,7 @@ <h2 id="debugging-with-pyocd">Debugging with pyOCD</h2>
 </code></pre>
 <h3 id="single-core-pyocd">Single-core (pyOCD)</h3>
 <p>For a single-core device, you need to add the relative path to the HEX file to <code>"initCommands"</code> - <code>"load"</code>.</p>
+<!-- markdownlint-disable-next-line MD036 -->
 <p><strong>Example</strong></p>
 <pre><code class="language-yml">{
     &quot;configurations&quot;: [
@@ -205,6 +206,7 @@ <h3 id="multi-core-pyocd">Multi-core (pyOCD)</h3>
 <p>add for each core the relative path to the AXF (ELF) files for each core to <code>"program"</code>.</p>
 </li>
 </ul>
+<!-- markdownlint-disable-next-line MD036 -->
 <p><strong>Example</strong></p>
 <pre><code class="language-yml">{
     &quot;configurations&quot;: [
@@ -253,8 +255,8 @@ <h3 id="multi-core-pyocd">Multi-core (pyOCD)</h3>
 <p>In this example, the <code>"set $pc = Reset_Handler",</code> is required to set the program counter to the correct value.</p>
 </div>
 <h2 id="debugging-with-j-link">Debugging with J-Link</h2>
-<p>For debugging with Segger J-Link (using the <a href="https://kb.segger.com/J-Link_GDB_Server">J-Link GDB Server</a>), the following is
-added to the <code>launch.json</code> file:</p>
+<p>For debugging with Segger J-Link (using the <a href="https://kb.segger.com/J-Link_GDB_Server">J-Link GDB Server</a>), the following
+is added to the <code>launch.json</code> file:</p>
 <pre><code class="language-yml">{
     &quot;configurations&quot;: [
     {
@@ -306,6 +308,7 @@ <h3 id="multi-core-j-link">Multi-core (J-Link)</h3>
 <p>add the XML file to the <code>"serverParameters"</code> so that the Segger GDB server can pick them up.</p>
 </li>
 </ul>
+<!-- markdownlint-disable-next-line MD036 -->
 <p><strong>Example</strong></p>
 <pre><code class="language-yml">{
     &quot;version&quot;: &quot;0.2.0&quot;,
@@ -347,6 +350,8 @@ <h3 id="multi-core-j-link">Multi-core (J-Link)</h3>
 }
 </code></pre>
 <p>For this example, the content of the <code>JLinkDevices.xml</code> file is as follows:</p>
+<!-- markdownlint-disable MD013 -->
+
 <pre><code class="language-xml">&lt;DataBase&gt;
   &lt;Device&gt;
     &lt;ChipInfo Vendor=&quot;AlifSemiconductor&quot; Name=&quot;AE722F80F55D5_HP&quot; Aliases=&quot;AE722F80F55D5LS_M55_HP; AE722F80F55D5AS_M55_HP&quot; /&gt;
@@ -356,6 +361,7 @@ <h3 id="multi-core-j-link">Multi-core (J-Link)</h3>
   &lt;/Device&gt;
 &lt;/DataBase&gt;
 </code></pre>
+<!-- markdownlint-enable MD013 -->
 
             </div>
           </div><footer>

debug_views.html

@@ -169,10 +169,12 @@ <h1 id="run-and-debug-view">Run and Debug view</h1>
 <a href="https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector">Eclipse CDT Cloud - Peripherals Inspector</a>.</p>
 </div>
 <h2 id="debug-toolbar">Debug toolbar</h2>
-<p>Once a debug session starts, the <strong>Debug toolbar</strong> appears at the top of the window. The toolbar contains actions to control
-the flow of the debug session, such as stepping through code, pausing execution, and stopping the debug session.</p>
+<p>Once a debug session starts, the <strong>Debug toolbar</strong> appears at the top of the window. The toolbar contains actions to
+control the flow of the debug session, such as stepping through code, pausing execution, and stopping the debug
+session.</p>
 <p><img alt="Debug toolbar" src="images/debug-toolbar.png" /></p>
 <p>The following table describes the actions available in the debug toolbar:</p>
+<!-- markdownlint-disable MD013 MD033 -->
 <table>
 <thead>
 <tr>
@@ -207,16 +209,17 @@ <h2 id="debug-toolbar">Debug toolbar</h2>
 </tr>
 </tbody>
 </table>
-<p>If your debugging sessions involve multiple targets (for example, a multi-core device), the debug toolbar shows the list
-of sessions and lets you switch between them.</p>
+<!-- markdownlint-enable MD013 MD033 -->
+<p>If your debugging sessions involve multiple targets (for example, a multi-core device), the debug toolbar shows the
+list of sessions and lets you switch between them.</p>
 <h2 id="variables-section">VARIABLES section</h2>
 <p>During a debugging session, you can inspect variables, expressions, and registers in the <strong>VARIABLES section</strong> of the
 <strong>Run and Debug view</strong> or by hovering over their source in the editor. Variable values and expression evaluation are
-relative to the selected stack frame in the <strong>CALL STACK section</strong>. In case of multi-core, registers are relative to the
-core that you are debugging.</p>
+relative to the selected stack frame in the <strong>CALL STACK section</strong>. In case of multi-core, registers are relative to
+the core that you are debugging.</p>
 <p><img alt="VARIABLES section" src="images/VARIABLES-section.png" /></p>
-<p>To change the value of a variable during the debugging session, right-click on the variable in the <strong>VARIABLES section</strong> and
-select <strong>Set Value</strong>.</p>
+<p>To change the value of a variable during the debugging session, right-click on the variable in the
+<strong>VARIABLES section</strong> and select <strong>Set Value</strong>.</p>
 <p>You can use the <strong>Copy Value action</strong> to copy the variable's value, or the <strong>Copy as Expression action</strong> to copy an
 iexpression to access the variable. You can then use this expression in the <a href="#watch-section"><strong>WATCH section</strong></a>.</p>
 <p>To filter variables by their name or value, use the Alt/Opt + Ctrl/Cmd + F keyboard shortcut while the focus is on the
@@ -226,8 +229,8 @@ <h2 id="watch-section">WATCH section</h2>
 <p>Variables and expressions can also be evaluated and watched in the Run and Debug view's WATCH section.</p>
 <p><img alt="WATCH section" src="images/WATCH-section.png" /></p>
 <h2 id="call-stack-section">CALL STACK section</h2>
-<p>The <strong>CALL STACK</strong> sections shows objects that are currently on stack. Threads are shown for applications that use an RTOS.
-Each object is associated to its location or value, and type.</p>
+<p>The <strong>CALL STACK</strong> sections shows objects that are currently on stack. Threads are shown for applications
+that use an RTOS. Each object is associated to its location or value, and type.</p>
 <p><img alt="CALL STACK section" src="images/call-stack-section.png" /></p>
 <p>The window content is updated automatically whenever program execution stops.</p>
 <p>The context menu allows to:</p>
@@ -240,8 +243,8 @@ <h2 id="call-stack-section">CALL STACK section</h2>
 </li>
 </ul>
 <h2 id="breakpoints-section">BREAKPOINTS section</h2>
-<p>A breakpoint pauses the execution of your code at a specific point, so you can inspect the state of your application at that
-point. VS Code supports several types of breakpoints.</p>
+<p>A breakpoint pauses the execution of your code at a specific point, so you can inspect the state of your
+application at that point. VS Code supports several types of breakpoints.</p>
 <h3 id="setting-breakpoints">Setting breakpoints</h3>
 <p>To set or unset a breakpoint, click on the editor margin or use <strong>F9</strong> on the current line.</p>
 <ul>
@@ -252,8 +255,8 @@ <h3 id="setting-breakpoints">Setting breakpoints</h3>
 <p>Disabled breakpoints have a filled gray circle.</p>
 </li>
 <li>
-<p>When a debugging session starts, breakpoints that can't be registered with the debugger change to a gray hollow circle.
-  The same might happen if the source is edited while a debug session without live-edit support is running.</p>
+<p>When a debugging session starts, breakpoints that can't be registered with the debugger change to a gray hollow
+circle. The same might happen if the source is edited while a debug session without live-edit support is running.</p>
 </li>
 </ul>
 <p><img alt="Breakpoint in the edirot margin" src="images/bkpt-in-editor-margin.png" /></p>
@@ -262,7 +265,8 @@ <h3 id="setting-breakpoints">Setting breakpoints</h3>
 <p><img alt="BREAKPOINTS section" src="images/breakpoints-section.png" /></p>
 <h3 id="breakpoint-types">Breakpoint types</h3>
 <h4 id="conditional-breakpoints">Conditional breakpoints</h4>
-<p>A powerful VS Code debugging feature is the ability to set conditions based on expressions, hit counts, or a combination of both.</p>
+<p>A powerful VS Code debugging feature is the ability to set conditions based on expressions, hit counts,
+or a combination of both.</p>
 <ul>
 <li>
 <p>Expression condition: The breakpoint is hit whenever the expression evaluates to true.</p>
@@ -301,7 +305,8 @@ <h4 id="conditional-breakpoints">Conditional breakpoints</h4>
 <p>Right-click on the breakpoint in the editor margin and select Edit Breakpoint.</p>
 </li>
 <li>
-<p>Select the pencil icon next for an existing breakpoint in the <strong>BREAKPOINTS section</strong> of the <strong>Run and Debug view</strong>.</p>
+<p>Select the pencil icon next for an existing breakpoint in the <strong>BREAKPOINTS section</strong> of
+the <strong>Run and Debug view</strong>.</p>
 </li>
 </ul>
 </li>
@@ -310,43 +315,45 @@ <h4 id="conditional-breakpoints">Conditional breakpoints</h4>
 </li>
 </ul>
 <h4 id="triggered-breakpoints">Triggered breakpoints</h4>
-<p>A triggered breakpoint is type of conditional breakpoint that is enabled once another breakpoint is hit. They can be useful
-when diagnosing failure cases in code that happen only after a certain precondition.</p>
-<p>Triggered breakpoints can be set by right-clicking on the glyph margin, selecting <strong>Add Triggered Breakpoint</strong>, and then
-choosing which other breakpoint enables the breakpoint.</p>
+<p>A triggered breakpoint is type of conditional breakpoint that is enabled once another breakpoint is hit. They can
+be useful when diagnosing failure cases in code that happen only after a certain precondition.</p>
+<p>Triggered breakpoints can be set by right-clicking on the glyph margin, selecting <strong>Add Triggered Breakpoint</strong>, and
+then choosing which other breakpoint enables the breakpoint.</p>
 <p><img alt="Creating a triggered breakpoint" src="images/triggered-bkpt.gif" /></p>
 <h4 id="inline-breakpoints">Inline breakpoints</h4>
-<p>Inline breakpoints are only hit when the execution reaches the column associated with the inline breakpoint. This is useful
-when debugging minified code, which contains multiple statements in a single line.</p>
-<p>An inline breakpoint can be set using <strong>Shift + F9</strong> or through the context menu during a debug session. Inline breakpoint
- are shown inline in the editor.</p>
-<p>Inline breakpoints can also have conditions. Editing multiple breakpoints on a line is possible through the context menu in
-the editor's left margin.</p>
+<p>Inline breakpoints are only hit when the execution reaches the column associated with the inline breakpoint.
+This is useful when debugging minified code, which contains multiple statements in a single line.</p>
+<p>An inline breakpoint can be set using <strong>Shift + F9</strong> or through the context menu during a debug session.
+Inline breakpoint are shown inline in the editor.</p>
+<p>Inline breakpoints can also have conditions. Editing multiple breakpoints on a line is possible through the
+context menu in the editor's left margin.</p>
 <h4 id="function-breakpoints">Function breakpoints</h4>
-<p>Instead of placing breakpoints directly in source code, a debugger can support creating breakpoints by specifying a function
-name. This is useful in situations where source is not available but a function name is known.</p>
-<p>To create a function breakpoint, select the + button in the <strong>BREAKPOINTS section</strong> header and enter the function name. Function
-breakpoints are shown with a red triangle in the <strong>BREAKPOINTS section</strong>.</p>
+<p>Instead of placing breakpoints directly in source code, a debugger can support creating breakpoints by specifying
+a function name. This is useful in situations where source is not available but a function name is known.</p>
+<p>To create a function breakpoint, select the + button in the <strong>BREAKPOINTS section</strong> header and enter the function
+name. Function breakpoints are shown with a red triangle in the <strong>BREAKPOINTS section</strong>.</p>
 <h4 id="data-breakpoints">Data breakpoints</h4>
-<p>If a debugger supports data breakpoints, they can be set from the context menu in the <strong>VARIABLES section</strong>. The Break on
-Value Change/Read/Access commands add a data breakpoint that is hit when the value of the underlying variable changes/is
-read/is accessed. Data breakpoints are shown with a red hexagon in the <strong>BREAKPOINTS section</strong>.</p>
+<p>If a debugger supports data breakpoints, they can be set from the context menu in the <strong>VARIABLES section</strong>. The Break
+on Value Change/Read/Access commands add a data breakpoint that is hit when the value of the underlying variable
+changes/is read/is accessed. Data breakpoints are shown with a red hexagon in the <strong>BREAKPOINTS section</strong>.</p>
 <h4 id="logpoints">Logpoints</h4>
-<p>A logpoint is a variant of a breakpoint that does not interrupt into the debugger, but instead logs a message to the debug
-console. Logpoints can help you save time by not having to add or remove logging statements in your code.</p>
+<p>A logpoint is a variant of a breakpoint that does not interrupt into the debugger, but instead logs a message to the
+debug console. Logpoints can help you save time by not having to add or remove logging statements in your code.</p>
 <p>A logpoint is represented by a diamond-shaped icon. Log messages are plain text but can also include expressions to be
 evaluated within curly braces ('{}').</p>
-<p>To add a logpoint, right-click in the editor left margin and select Add Logpoint, or use the <strong>Debug: Add Logpoint...</strong>
-command in the Command Palette (<strong>Ctrl/Cmd + Shift + p</strong>).</p>
+<p>To add a logpoint, right-click in the editor left margin and select Add Logpoint, or use the
+<strong>Debug: Add Logpoint...</strong> command in the Command Palette (<strong>Ctrl/Cmd + Shift + p</strong>).</p>
 <p><img alt="Creating a logpoint" src="images/create-logpoint.gif" /></p>
-<p>Just like regular breakpoints, logpoints can be enabled or disabled and can also be controlled by a condition and/or hit count.</p>
+<p>Just like regular breakpoints, logpoints can be enabled or disabled and can also be controlled by a condition
+and/or hit count.</p>
 <h2 id="peripheral-inspector">PERIPHERAL Inspector</h2>
 <p>The Eclipse CDT Cloud <strong>Periperhal Inspector</strong> is a standalone SVD Viewer extension.</p>
 <p><img alt="Peripheral Inspector" src="images/peripheral-inspector.png" /></p>
 <p>For more information, refer to the
 <a href="https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector">Peripheral Inspector GitHub repository</a>.</p>
 <h2 id="memory-inspector">Memory Inspector</h2>
-<p>The Eclipse CDT Cloud <strong>Memory Inspector</strong> provides a powerful and configurable memory viewer that works with debug adapters.</p>
+<p>The Eclipse CDT Cloud <strong>Memory Inspector</strong> provides a powerful and configurable memory viewer that works with
+debug adapters.</p>
 <p><img alt="Memory Inspector" src="images/memory-inspector.png" /></p>
 <p>It features:</p>
 <ul>
@@ -387,23 +394,21 @@ <h2 id="disassembly-view">Disassembly View</h2>
 <p>The <strong>Disassembly View</strong> shows the program execution in assembly code intermixed with the source code.</p>
 <p>To open the <strong>Disassembly View</strong>:</p>
 <ul>
-<li>
-<p>press <strong>Ctrl/Cmd + Shift + p</strong> and select "Open Disassembly View" or</p>
-</li>
-<li>
-<p>Right-click an item in the <a href="#call-stack-section"><strong>CALL STACK section</strong></a> and select "Open Disassembly View"</p>
-</li>
+<li>press <strong>Ctrl/Cmd + Shift + p</strong> and select "Open Disassembly View" or</li>
+<li>Right-click an item in the <a href="#call-stack-section"><strong>CALL STACK section</strong></a> and select "Open Disassembly View"</li>
 </ul>
 <p><img alt="Disassembly View" src="images/disassembly-view.png" /></p>
 <h2 id="debug-console">Debug Console</h2>
-<p>The <strong>Debug Console</strong> enables viewing and interacting with the output of your code running in the debugger. Expressions can
+<p>The <strong>Debug Console</strong> enables viewing and interacting with the output of your code running in the debugger.
+Expressions can
 be evaluated with the <strong>Debug Console REPL</strong> (Read-Eval-Print Loop) feature.</p>
 <p>With the CMSIS Debug extension, you can use the Debug Console REPL to enter
-<a href="https://sourceware.org/gdb/current/onlinedocs/gdb.html/index.html">GDB commands</a> while debugging. Before entering a GDB
-command, you have to explicitly enter a "greater-than"-character <code>&gt;</code> so that the following strings can be evaluated as a GDB
-command.</p>
+<a href="https://sourceware.org/gdb/current/onlinedocs/gdb.html/index.html">GDB commands</a> while debugging. Before entering
+a GDB command, you have to explicitly enter a "greater-than"-character <code>&gt;</code> so that the following strings can be
+evaluated as a GDB command.</p>
 <p>Debug Console input uses the mode of the active editor, which means that it supports syntax coloring, indentation, auto
 closing of quotes, and other language features.</p>
+<!-- markdownlint-disable-next-line MD036 -->
 <p><strong>Example</strong></p>
 <p>The following example shows how to check the currently set breakpoints with the <code>&gt; info break</code> command. Afterwards, the
 application is run with the <code>&gt; continue</code> command.</p>