Skip to content

Commit 478918e

Browse files
Updating documents for MVVS 2.7.0
1 parent 0f0e72f commit 478918e

10 files changed

+57
-7
lines changed
42.8 KB
Loading
-31.7 KB
Loading
-23.9 KB
Loading
4.32 KB
Loading
33.6 KB
Loading
70.9 KB
Loading

docs/usage/Compatibility.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# U2 Product Compatibility
2+
3+
For the Rocket MV BASIC Extension product, not all features are currently supported on all U2 products & platforms. Users need to pay attention to the U2 product version and platform information first, as some feature may not working properly.
4+
5+
For more details, please refer [Rocket-MV-BASIC-Extension-features-support-matrix](https://my.rocketsoftware.com/RocketCommunity/s/article/Rocket-MV-BASIC-Extension-features-support-matrix).
6+
17
# VS Code Compatibility
28

39
Upgrading VS Code may potentially introduce some issues that could result in anomalies with the compilation or debugging functions of our extension. In such cases, you can consider downgrading VS Code as a workaround. We have summarized a list of recent stable versions of VS Code for your reference.

docs/usage/Debugging.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ The following U2 server versions and platforms are supported:
66

77
### UniVerse
88

9-
Versions: 11.3.2 or higher
9+
Versions: For offline mode debugging 11.3.2 or higher and for online mode debugging 11.4.1 and higher
1010

1111
Platforms: Windows, Linux, AIX
1212

1313
### UniData
1414

15-
Versions: 8.2.4
15+
Versions: For offline mode debugging 8.2.4 or higher and for online mode debugging 8.3.1 and higher
1616

1717
Platforms: Windows, Linux, AIX
1818

@@ -26,7 +26,7 @@ A high-performance debugging feature is supported on UniVerse 11.4.1 and UniData
2626

2727
### Connecting to a U2 server account folder
2828

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.
29+
Before using the debugging feature, you must connect to a U2 server account folder firstly. Please see the [Connection section](./Connection.md) for offline mode and [Online Editing](./OnlineEditing.md) for online mode to learn how to connect to a U2 server account.
3030

3131
**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.
3232

@@ -39,6 +39,8 @@ Before debugging, open the BASIC program first.
3939
**Note**: debugging a BASIC subroutine directly is not allowed.
4040

4141
### Debugging without a launch file
42+
> **Note** :
43+
> Debugging without a launch file works properly in offline mode only; in online mode, the behavior is uncertain.
4244
4345
- Click the **Run and Debug** icon on from the left menu bar. The **Run and Debug** view will display if you have no `launch.json` file in your project.
4446

@@ -92,6 +94,8 @@ Then a default debugging configuration file launch.json will be generated in dir
9294
- "dependencies": put other BASIC program files' absolute paths here if they need to be compiled before debugging. For example, "C:\U2\UV\XDEMO\TEST".
9395
- "arguments": put additional debugging online· here. Please refer to your UniVerse / UniData user documentation for more details. By default, this setting doesn’t appear in the configuration file, but can be added manually if needed.
9496

97+
For online mode create build task as mentioned in [Online Editing](./OnlineEditing.md)
98+
9599
From the **Run and Debug** view, set the launch option to **Launch Program**. Then press the F5 button to start debugging.
96100

97101
![](../img/debug_launch_program.png)
@@ -100,6 +104,10 @@ From the **Run and Debug** view, set the launch option to **Launch Program**. Th
100104

101105
The following debug operations are supported.
102106

107+
>**Note**
108+
>
109+
>In online mode, the source code is accessed virtually. When debugging starts, the source code always comes from the U2 debugger service, (which is why a different file is launched for debugging).
110+
103111
### Setting break point
104112

105113
When debugging starts, you can set a break point by:
@@ -114,6 +122,12 @@ You can find all break points in **BREAKPOINTS** panel of the **Run and Debug**
114122

115123
![](../img/debug_breakpoints_view.png)
116124

125+
>**Note**
126+
>
127+
>In online mode, a different file is launched for debugging, so and breakpoints are applied to that file as well. As a result, the user will see the same breakpoints in the "BREAKPOINTS" view, but in two different files.
128+
>
129+
> ![](../img/online_debug_multiple_breakpoints.png)
130+
117131
The program will stop when the process encounters a break point.
118132

119133
**Note**: Condition breakpoints are not supported.

docs/usage/KnownIssues.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Known Issues
22

3-
> **NOTE:**
4-
>
5-
> We have moved this section to following link [MVVS Tech Note](https://my.rocketsoftware.com/RocketCommunity/s/article/Notices-for-MVVS-Release-2-6-0)
3+
## For 2.7.0 release
4+
[MVVS Tech Note for Release 2.7.0](https://my.rocketsoftware.com/RocketCommunity/s/article/Notices-for-MVVS-Release-2-7-0)
5+
6+
7+
## For 2.6.0 release
8+
[MVVS Tech Note for Release 2.6.0](https://my.rocketsoftware.com/RocketCommunity/s/article/Notices-for-MVVS-Release-2-6-0)

docs/usage/OnlineEditing.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,30 @@ In the Configure Patterns option, enter the account/folder/file name patterns yo
113113
**View Filtered Results**:
114114
* Expand the specific server or folder to see only the filtered accounts, folders, and files.
115115

116+
### Search BASIC programs
117+
118+
Users can search for BASIC programs within a folder. Users can specify a search pattern or text to find specific files. This feature is designed for quick access to files, eliminating the need to scroll through the VS Code file view.
119+
120+
In the Search option, enter the file name pattern you want to match. Pattern matching characters are:
121+
* \* = any string
122+
* ? = any character
123+
124+
#### **Steps to Search BASIC programs**
125+
**Access Configuration**:
126+
* Right-click the folder inside Account.
127+
* Select the "Search" option.
128+
129+
![](../img/online_editing_search_option.png)
130+
131+
**Enter Search Pattern**:
132+
* Enter the file name or search criteria and click Enter.
133+
134+
![](../img/online_editing_search_criteria.png)
135+
136+
**View Search Results**:
137+
* Users can view search result in "SEARCH RESULTS" view and open files directly from that view.
138+
![](../img/online_editing_search_results_view.png)
139+
116140

117141
### Editing BASIC programs
118142

@@ -157,7 +181,7 @@ Clicking on 'Catalog' will use the parameters from the basic.mvbasic.json file t
157181

158182
#### Compile / Catalog with configuration file
159183
The configuration file can help a user to compile and catalog multiple files.
160-
Select “Configure Default Build Task…” from the Terminal menu, and then select “BASIC: Online Editing build” to create a build task.
184+
Select “Configure Default Build Task…” from the Terminal menu, and then select “BASIC: Build” to create a build task.
161185

162186
![](../img/online_editing_compile_2.png)
163187

@@ -167,6 +191,9 @@ A default task file will be generated. For more information on this file, see th
167191

168192
![](../img/online_editing_compile_4.png)
169193

194+
### Debugging in online mode
195+
Refer [Debugging](./Debugging.md) for debugging steps.
196+
170197
### Limitation:
171198
Most of the LSP (Language Server Protocol) features are supported, but there are some limitations.
172199

0 commit comments

Comments
 (0)