Skip to content

Commit 969748a

Browse files
committed
Enhance debugging overview page
1 parent 7bf8420 commit 969748a

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

astro.config.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ export default defineConfig({
100100
},
101101
{
102102
label: 'Debugging',
103+
badge: {
104+
text: 'Updated',
105+
variant: 'success'
106+
},
103107
collapsed: true,
104108
items: [
105109
{

src/content/docs/developing/debug/overview.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Overview
33
---
44
import { Aside, CardGrid, Card, Icon, Tabs, TabItem } from '@astrojs/starlight/components';
55

6-
# ILE Debugging
6+
## Debugging
77

8-
Debugging ILE programs is now available inside of Visual Studio Code.
8+
Debugging IBM i programs is now available inside of Visual Studio Code.
99

1010
<Aside type="note">You must have `bash` set as your default shell. [See Bash Shell Required](/docs/tips/bash/) for more info. </Aside>
1111

12-
## Supported Features
12+
### Supported Features
1313

1414
Supported language types:
1515

@@ -42,14 +42,14 @@ Supported service entry point debug features:
4242
- Saving service entry points across multiple IDE sessions
4343
- Refreshing service entry points after programs are recompiled
4444

45-
## Limitations
45+
### Limitations
4646

4747
The following features are not supported in the current release:
4848
- Code coverage
4949

5050

5151

52-
# Starting to debug
52+
## Starting to debug
5353

5454
<CardGrid>
5555

@@ -93,7 +93,7 @@ To debug a program from the Object Browser, right-click on the program object an
9393

9494
</Card></CardGrid>
9595

96-
## Managing Service Entry Points
96+
### Managing Service Entry Points
9797
<CardGrid>
9898

9999
<Card>
@@ -109,7 +109,7 @@ Service Entry Point (SEP) can be set using the **Set Service Entry Point** popup
109109
- Service Entry Points are saved in the debug service job on the host. When a new debug client connects to a running debug service, it will restore the saved service entry points for the current user.
110110
- If a program or service program is recompiled, you can use the **Refresh** action from the context menu to refresh the selected SEP, or use the **Refresh All Service Entry Points** toolbar action to refresh all SEPs in the **Service Entry Points** view.
111111

112-
## Settings
112+
### Settings
113113

114114
The following settings are available from the **Debugger** tab of the **IBM i: Connection Settings** page. The page can be accessed from the Command Palette.
115115

@@ -124,25 +124,25 @@ The following settings are available from the **Debugger** tab of the **IBM i: C
124124
The debug port and SEP debug port are specified in the DebugService.env file on the host.
125125

126126

127-
# Common issues
127+
## Common issues
128128

129-
## Debug hangs
129+
### Debug hangs
130130

131131
There is a [known issue](https://github.com/codefori/vscode-ibmi/issues/1059)<Icon name="github" class="icon-inline" /> that when you start debugging from VS Code, the debugger hangs and doesn't launch.
132132

133133
The fix is to check if you've got a prior debug job stuck in `MSGW`. You can do this with `WRKACTJOB`, or a similar command like `WRKSBSJOB QBATCH`.
134134

135135
**Users should no longer face this issue** as we now submit debug jobs to `QSYSWRK` with `QSYSNOMAX`.
136136

137-
## `STRDBGSVR` requirement
137+
### `STRDBGSVR` requirement
138138

139139
The Debug Service that is started depends on the traditional Debug Server.
140140

141141
![](./error_2.png)
142142

143143
If you receive this message, do as it says. Simply start the Debug Server with `STRDBGSVR` from a greenscreen.
144144

145-
## IP not in cert list
145+
### IP not in cert list
146146

147147
**It is always recommended you use a hostname in the connection settings to make use of the debugger**.
148148

@@ -166,7 +166,7 @@ Your entry might look like this:
166166

167167
If you find that you've added your local hostname entry and the error is still occurring, then you may need to delete the existing certificates from `/QIBM/ProdData/IBMiDebugService/bin/certs` on the IFS and generate them again in the Walkthrough.
168168

169-
# Frequently Asked Questions
169+
## Frequently Asked Questions
170170

171171
**Question**: Can I pass parameters to the batch program being debugged?
172172
**Answer**: Use the **Debug As Batch** action, change **Command used to start debugging** to specify program parameters.

0 commit comments

Comments
 (0)