Skip to content

Commit 6ff3b67

Browse files
committed
Update docs for 1.7.0 release
1 parent 9a7ec43 commit 6ff3b67

6 files changed

Lines changed: 48 additions & 70 deletions

File tree

docs/img/debug_input.png

81 KB
Loading

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This extension includes the following features:
2222
- Add customized documentation for functions, subroutines, or labels
2323
- Show syntax and grammar errors
2424
- Prompt parameters of BASIC internal functions
25-
- Compile / Catalog BASIC programs on the U2 server
25+
- Compile / Catalog / Debug BASIC programs on the U2 server
2626

2727
## Restriction
2828

docs/usage/CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# Change Log
22

3+
## Version 1.7.0: Auguest 17, 2022
4+
5+
- Feature: (Preview) support debugging functionalities on UniData 8.2.4.
6+
- Bug fix: improve the stability of debugging.
7+
- Bug fix: improve file parsing performance.
8+
39
## Version 1.6.0: April 29, 2022
410

5-
- Feature: (Preview) support debug BASIC program files on UniVerse. Please refer online documentation to see known issues.
11+
- Feature: (Preview) support debug BASIC program files on UniVerse. Please refer online documentation about known issues.
612
- Bug fix: show connection icon only when extension activated.
713

814
## Version 1.5.0: March 31, 2022

docs/usage/Compile.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Users can compile and catalog BASIC programs using this extension.
55
**Note**:
66

77
- Before compiling BASIC programs, a U2 server must be connected. For information on connecting to a U2 server, please see [this section](./Connection.md).
8-
- After compiling, regardless of whether the compile succeeds or fails, the BASIC files will be synchronized to the U2 server, overwriting the existing ones and new files will also be created.
8+
- After compiling, regardless of whether the compile succeeds or fails, the BASIC files will be synchronized to the U2 server, overwriting the existing ones and new files will also be created.
99
- Generated objective files will not be synchronized from the server to the local machine.
10-
- Compilation does not work properly when VS Code and the extension run on Linux platform.
10+
- Compilation does not work properly when VS Code and the extension installed on Linux platform.
1111

1212
## Compile and catalog
1313

@@ -45,7 +45,7 @@ By using VS Code task, users can compile or catalog multiple BASIC programs at t
4545

4646
#### Create a BASIC build task
4747

48-
Select "Run Build Task ..." from the "Terminal" menu to open the Command Palette.
48+
Select "Configure Default Build Task ..." or "Configure Tasks ..." from the "Terminal" menu to open the Command Palette.
4949

5050
![](../img/compile_from_menu_1.png)
5151

docs/usage/Debugging.md

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,34 @@
11
## Debugging (Preview)
22

3-
With the debugging function, you can easily debug BASIC programs, observe, track the results and changes to variables for each step when running a BASIC program.
3+
With the debugging function, user can easily debug BASIC programs, observe, track the results and changes to variables for each step when running a BASIC program.
44

5-
The current version of the debugging function is a preview version and is only supported for UniVerse the v11.3.4 and 12.1.1 releases. There are limits to debugging features and not all debugging functions are stable.
5+
The 1.7.0 version of the debugging function is a preview version. There are limitations to the debugging features and not all debugging functions are stable. The following U2 server versions and platforms are supported:
66

7-
Please refer [Known issues](./KnownIssues.md) list to find out existing issues in debugging feature.
8-
9-
### Setup Environment
10-
11-
To support the debugging function, a DAP server will run on the UniVerse server side. In this preview version, you need download the DAP server binaries and add them to UniVerse manually. In future releases, this process will be automated.
12-
13-
### Downloading DAP Server
14-
15-
You must login to [RBC platform](https://rbc.rocketsoftware.com/) to download DAP server binaries. Follow below steps to download related binaries:
16-
17-
1) Click button "Search Product Availability"
18-
19-
2) Select "Product" to "MV BASIC for VS Code", and select "Windows" (binaries for Linux platform are also in this package)
20-
21-
3) In "1.6.0" release, click the "Product" download link
22-
23-
### Installing the DAP server binaries
24-
25-
You need copy the DAP binaries to the U2 server manually. Complete the steps below to configure the environment.
26-
27-
#### Linux Platform
28-
29-
1) Copy **uvdap_server** and **uvdap_slave** to the *$UVHOME/bin* folder. *$UVHOME* is the installation path for UniVerse.
30-
31-
Ensure permission accordingly to installed release for permission, owner, and group similar to **uvapi_server** and **uvapi_slave**.
32-
33-
2) Open the **unishared** folder and find the unirpc services file (unishared/unirpc/unirpcservices). Ensure you have write permissions to the file.
34-
35-
3) Open the **unirpcservices** file and add the following new line to unirpcservices:
36-
37-
```
38-
uvdaps <absolute file path of uvdap_server> * TCP/IP 0 3600
39-
```
7+
### UniVerse
408

41-
**Note**: You will need to change to the root user to update this file.
9+
Versions: 12.1.1 and before
4210

43-
If you encounter some permission issues during debugging, please try following commands to change these binaries' ownership.
11+
Platforms: Windows, Linux, AIX
4412

45-
```
46-
chmod 755 uvdap*
47-
chown uvdb uvdap*
48-
chgrp input uvdap*
49-
```
13+
### UniData
5014

51-
#### Windows Platform
15+
Versions: 8.2.4
5216

53-
1) Copy the **uvdap_server.exe** and **uvdap_slave.exe** files to the UniVerse bin folder. By default, UniVerse is installed to **"C:\U2\UV"**, and its bin folder is **"C:\U2\UV\bin"**.
17+
Platforms: Windows, Linux, AIX
5418

55-
2) Open the **unishared** folder and find the unirpc services file named **unirpcservices**. By default, the **unishared** folder installation path is **"C:\U2\unishared"**, and you can find file **unirpcservices** under **"C:\U2\unishared\unirpc"**.
19+
Please refer [Known issues](./KnownIssues.md) list to find out existing issues in debugging feature.
5620

57-
3) Open file **unirpcservices** file and add the following new line to it:
21+
### Setup Environment
5822

59-
```
60-
uvdaps <absolute file path of uvdap_server> * TCP/IP 0 3600
61-
```
23+
In the 1.6.0 release, additional binaries should be installed on UniVerse to support the debugging features. This is no longer necessary for the 1.7.0 release.
6224

6325
## Start Debugging
6426

65-
### Connecting to a UniVerse account folder
27+
### Connecting to a U2 server account folder
6628

67-
Before using the debugging feature, you must first connect to a UniVerse account folder. Please see the [Connection section](./Connection.md) to learn how to connect to a UniVerse server.
29+
Before using the debugging feature, you must connect to a U2 server account folder firstly. Please see the [Connection section](./Connection.md) to learn how to connect to a U2 server account.
6830

69-
**Note**: The debugging feature only works on **UniVerse** 11.3.4 and 12.1.1 releases in this preview version. The debugging feature will not work if you only open a single BASIC program file in VS Code. You must open an account folder.
31+
**Note**: The debugging feature will not work if you only open a single BASIC program file in VS Code. You must open an account folder.
7032

7133
### Debugging BASIC files
7234

@@ -84,8 +46,6 @@ Before debugging, open the BASIC program first.
8446

8547
The BASIC program file will be compiled first. If successful, the debugging process will stop at the first runnable line of code in the program file.
8648

87-
![](../img/debug_start.png)
88-
8949
### Debug with launch file
9050

9151
You can also configure a `launch.json` file for debugging.
@@ -153,21 +113,27 @@ The program will stop when the process encounters a break point.
153113

154114
When the process encounters a break point, the program will stop running. You can press the F5 key or click the Continue button from the debug panel to continue running the program.
155115

116+
**Note**: Program cannot jump out of a subroutine through this operation in UniVerse.
117+
156118
![](../img/debug_continue.png)
157119

158120
### Step over
159121

160122
The step over function allows you to run the program line-by-line. Press the F10 button or click the Step Over button from the debug panel to run one line of the program.
161123

124+
**Note**: Program cannot jump out of a subroutine through this operation in UniVerse.
125+
162126
![](../img/debug_step_over.png)
163127

164128
### Step into and step out
165129

166130
These two operations are still not stable. They partially work if breakpoints are set at CALL line. Please refer [Known Issues](./KnownIssues.md).
167131

132+
**Note**: Program cannot jump out of a subroutine through **Step Out** operation in UniVerse.
133+
168134
## Restart debug
169135

170-
This operation is currently not supported.
136+
This operation is currently NOT supported.
171137

172138
### Stop debugging
173139

@@ -190,3 +156,9 @@ You can also add variables to the **WATCH** panel.
190156
Click the plus (+) button from the **WATCH** panel and enter the variable name to display the variable’s value.
191157

192158
![](../img/debug_add_watch.png)
159+
160+
### Handle input operation
161+
162+
You can switch to the VS Code terminal to handle an INPUT statement during BASIC program running.
163+
164+
![](../img/debug_input.png)

docs/usage/KnownIssues.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,23 @@
22

33
## Debugging Preview
44

5-
**MVVS-711** Step-in may terminate debugging session.
5+
**MVVS-793** Sometimes the stack trace could not be displayed correctly and could not focus on correct line.
66

7-
**MVVS-713** Sometimes unable to step out at the end of CALL subroutine.
7+
**MVVS-802** "Internal error " shows in VARIABLES view when debug basic in UD windows
88

9-
**MVVS-722** Unable to use step in/out on Windows platform.
9+
**MVVS-803** unable to recognize INPUT value during debugging in VS Code sometimes
1010

11-
**MVVS-725** Unable to run debugging in multiple workspace folders.
11+
**MVVS-805** unable to debug with lanch.json file in some cases
1212

13-
## Others
13+
**MVVS-808** unable to debugging with long variable length for UD
1414

15-
**MVVS-527** BASIC CALL subroutines statement can not be recognized correctly by the parser.
15+
**MVVS-814** Debug with launch.json will automatically catalog program if specified dependencies BASIC and launch.json has catalog option
16+
17+
**MVVS-815** MVVS spends lots of time drawing dimension of big array
1618

17-
**MVVS-547** Unable to connect / disconnect U2 server when parser is busy.
19+
## Others
1820

19-
**MVVS-567** Sometimes the extension could not be activated successfully.
21+
**MVVS-527** BASIC CALL subroutines statement can not be recognized correctly by the parser.
2022

2123
**MVVS-590** READU statement syntax highlight incorrect and misleading.
2224

@@ -26,6 +28,4 @@
2628

2729
**MVVS-671** Can't connect to UniData demo account on linux.
2830

29-
**MVVS-678** When open a network file path in the VS Code, the extension will be failed to activate.
30-
3131
**MVVS-707** Compilation incorrect status if user has no permission to edit files on U2 server.

0 commit comments

Comments
 (0)