Skip to content

Commit a2e315d

Browse files
committed
Additional information regarding Version 2
Signed-off-by: worksofliam <mrliamallan@live.co.uk>
1 parent 778df13 commit a2e315d

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

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

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debugging
33
---
4-
import { Aside, CardGrid, Card, Icon } from '@astrojs/starlight/components';
4+
import { Aside, CardGrid, Card, Icon, Tabs, TabItem } from '@astrojs/starlight/components';
55

66
# ILE Debugging
77

@@ -57,20 +57,35 @@ To debug a program from the Object Browser, right-click on the program object an
5757

5858
* PTFs
5959
* Certificates setup on the server
60-
* created in `/QIBM/UserData/IBMiDebugService/certs`
60+
* created in `/QIBM/UserData/IBMiDebugService/certs` by default
6161
* IBM i Debug extension
6262
* installed into Visual Studio Code
63-
* Local client certificate (**optional**)
63+
* Local client certificate
6464
* can be imported with the 'Import local certificate' command
6565

6666
## Required PTFs
6767

6868
To make use of the Debug Service, you need the following PTFs:
6969

70+
<Tabs>
71+
<TabItem label="Version 1">
72+
7073
* Host debugger in 5770SS1:
7174
* IBM i 7.5 PTF SI83666 and SI81035
7275
* IBM i 7.4 PTF SI83683 and SI81031
7376
* IBM i 7.3 PTF SI83692 and SI80858
77+
* Java 8 is required
78+
* `/QOpenSys/QIBM/ProdData/JavaVM/jdk80/64bit`
79+
80+
</TabItem>
81+
<TabItem label="Version 2">
82+
83+
* *Version 2 not yet released.*
84+
* Java 11 is required
85+
* `/QOpenSys/QIBM/ProdData/JavaVM/jdk11/64bit`
86+
87+
</TabItem>
88+
</Tabs>
7489

7590
After you have installed the PTFs, the connection inside of Visual Studio Code will need to be restarted.
7691

@@ -88,12 +103,12 @@ After connecting to a system in Code for IBM i, if the PTFs are installed but th
88103

89104
</Card></CardGrid>
90105

91-
---
92-
93106
<Aside type="tip">
94-
There only needs to be one instance of the Debug Service running. All developers share the Debug Service.
107+
There only needs to be one instance of the Debug Service running and therefore the certificates should only be generated once. All developers share the Debug Service.
95108
</Aside>
96109

110+
---
111+
97112
### Generating certificates
98113

99114
<CardGrid>
@@ -104,6 +119,8 @@ This Walkthrough can easily configure the Debug Service and start it up. The las
104119

105120
*It will ask you to confirm the initialisation.*
106121

122+
If certificates already exist on the server, you may see a slightly different message as Code for IBM i will not replace existing certificates.
123+
107124
</Card><Card>
108125

109126
![](./setup2_a.png)
@@ -118,7 +135,7 @@ This Walkthrough can easily configure the Debug Service and start it up. The las
118135

119136
<Card>
120137

121-
The 'Start debug service' button will spin up the Debug Service. If the Debug Service is already running, it will ask you if you want to end the existing instance before starting a new one - this is a requirement. It is not recommended to run two instances of the Debug Service at once.
138+
The 'Start debug service' button will spin up the Debug Service. If the Debug Service is already running, it will ask you if you want to end the existing instance before starting a new one - this is a requirement if you have generated new certificates on the server. It is not recommended to run two instances of the Debug Service at once.
122139

123140
</Card><Card>
124141

@@ -142,19 +159,23 @@ You can also start the Debug Service through the command palette:
142159

143160
## Debug Service ports
144161

145-
The Debug Service depends on two ports by default:
162+
The Debug Service depends on three ports by default:
146163

147164
* Port 8001 (unsecure port)
148165
* this port is not used for anything in regards to debugging, though it is required to start and stop the Debug Service
149166
* Port 8005 (secure port)
150167
* this port is used by all debugging clients and is required to start the Debug Service.
168+
* Port 8008
169+
* this port is used for Service Entry Breakpoint (*only applies to version 2 of the Debug Service*)
170+
171+
While you can configure the ports in the Connection Settings, it is recommended the defaults are used for consistency.
151172

152-
These ports can be changed in `/QIBM/ProdData/IBMiDebugService/bin/DebugService.env`, both `DBGSRV_PORT` and `DBGSRV_SECURED_PORT` respectively.
173+
{/* These ports can be changed in `/QIBM/ProdData/IBMiDebugService/bin/DebugService.env`, both `DBGSRV_PORT` and `DBGSRV_SECURED_PORT` respectively.
153174
154175
If `DBGSRV_SECURED_PORT` is changed, make sure to:
155176
156177
* restart the Debug Service
157-
* change the Debug Service port number in the connection settings to your new port (`DBGSRV_SECURED_PORT`). **Every user will need to do this step.**
178+
* change the Debug Service port number in the connection settings to your new port (`DBGSRV_SECURED_PORT`). **Every user will need to do this step.** */}
158179

159180
# FAQ
160181

0 commit comments

Comments
 (0)