Skip to content

Commit 531937b

Browse files
committed
Update content for additional parameters (1.9.0)
1 parent 2ff3dae commit 531937b

4 files changed

Lines changed: 48 additions & 9 deletions

File tree

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Requirements: [VS Code](https://code.visualstudio.com/) 1.70.2 or higher version
6262

6363
**Note**: Using this method, an existing working environment that requires a different version of Java would not be impacted and the extension will work properly in the Java 11 (or above) environment.
6464

65-
3. Select "File" > "Open Folder" to pen a folder that contains the BASIC program files you want to view or edit. You can also add multiple folders to the workspace using "File" > "Add Folder to Workspace". We recommend that you open the U2 account level folders to avoid encountering exceptions.
65+
3. Select "File" > "Open Folder" to open a folder that contains the BASIC program files you want to view or edit. You can also add multiple folders to the workspace using "File" > "Add Folder to Workspace". We recommend that you open the U2 account level folders to avoid encountering exceptions.
6666

6767
**Note**: This extension is designed to work with folders/directories rather than individual program files. If you open a single file, some functions may be limited.
6868

docs/usage/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Change Log
22

3+
## Version 1.9.0: January 5, 2023
4+
5+
- Enhancement: support additional parameters for compilation
6+
- Enhancement: support additional parameters for debugging
7+
38
## Version 1.8.0: October 27, 2022
49

510
- Feature: support logging system. Please refer online documentation for details.

docs/usage/Compile.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ A default build task configuration will be created and displayed in the editor.
6363
"type": "BASIC",
6464
"targets": [],
6565
"compile": {
66-
"dataSource": "UNIVERSE"
66+
"dataSource": "UNIVERSE",
67+
"arguments": ""
6768
},
6869
"problemMatcher": [],
6970
"label": "BASIC: Build",
@@ -89,7 +90,7 @@ You can find task properties in the [VS Code official documents](https://code.vi
8990
- **language**: (For UniData only) The programming language flavor. Must be "UniBasic" or "Pick". If not set, "UniBasic" is the default.
9091
- **catalog**: For UniVerse, you can select "global", "local" or "normal". For UniData, you can select "global", "local" or "direct". If not set, files will not be cataloged.
9192
- **initialCharacter**: (For UniVerse only) The initial character of the cataloged program can only be set when the **catalog** parameter is set to “global”.
92-
93+
- **arguments**: Put additional compilation arguments here. For more details, please refer UniVerse / UniData user manual for more details. By default, this setting doesn’t appear in the configuration file. Please add it manually if needed.
9394
#### Run build task
9495

9596
Select "Run build task" from the "Terminal" menu to start the build task.
@@ -99,7 +100,6 @@ Select "Run build task" from the "Terminal" menu to start the build task.
99100
![](../img/compile_from_menu_3.png)
100101

101102

102-
103103
## UniVerse Compile Task Examples
104104

105105
**Example 1**. Compile a single BASIC program without cataloging.
@@ -361,3 +361,31 @@ Select "Run build task" from the "Terminal" menu to start the build task.
361361

362362
- Add another task object in "tasks"
363363
- Change "label" in the tasks, When run build tasks, you can select one of these tasks
364+
365+
**Example 4**. Additional compilation arguments
366+
367+
```json
368+
{
369+
"version": "2.0.0",
370+
"tasks": [
371+
{
372+
"type": "BASIC",
373+
"targets": [
374+
"BP/SAMPLE_FILE"
375+
],
376+
"compile": {
377+
"dataSource":"UNIVERSE",
378+
"arguments": "-L -X"
379+
},
380+
"problemMatcher": [],
381+
"label": "BASIC: Build",
382+
"group": {
383+
"kind": "build",
384+
"isDefault": true
385+
}
386+
}
387+
]
388+
}
389+
```
390+
391+
- Compile the BASIC program with arguments "-L" and "-X".

docs/usage/Debugging.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Debugging (Preview)
1+
## Debugging
22

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.
3+
With the debugging function, users can easily debug BASIC programs, as well as observe and track the results and changes to variables for each step when running a BASIC program.
44

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:
5+
The following U2 server versions and platforms are supported:
66

77
### UniVerse
88

9-
Versions: 12.1.1 and before
9+
Versions: 11.3.2 or higher
1010

1111
Platforms: Windows, Linux, AIX
1212

@@ -24,6 +24,8 @@ In the 1.6.0 release, additional binaries should be installed on UniVerse to sup
2424

2525
## Start Debugging
2626

27+
**Note**: You should not debug BASIC subroutines direcly, because this not allowed in UniVerse and UniData.
28+
2729
### Connecting to a U2 server account folder
2830

2931
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.
@@ -36,6 +38,8 @@ There are 2 methods to debug a BASIC program file: debugging without a launch fi
3638

3739
Before debugging, open the BASIC program first.
3840

41+
**Note**: debugging a BASIC subroutine directly is not allowed
42+
3943
### Debugging without a launch file
4044

4145
- Click the **Run and Debug** icon on left menu bar. The **Run and Debug** view will display if you have no `launch.json` file in your project.
@@ -71,7 +75,8 @@ Then a default debugging configuration file launch.json will be generated in dir
7175
"program": "",
7276
"stopOnEntry": true,
7377
"preLaunchTask": "BASIC: Build",
74-
"dependencies": []
78+
"dependencies": [],
79+
"arguments": ""
7580
}
7681
]
7782
}
@@ -84,6 +89,7 @@ Then a default debugging configuration file launch.json will be generated in dir
8489
- "stopOnEntry": used to control whether the program will be stopped at the first runnable line when start debugging. Currently only true is supported.
8590
- "preLanuchTask": this is used to run pre-required task before debugging. In our extension, we use this setting to compile the BASIC program in setting "program" first.
8691
- "depenedncies": put other BASIC program files here if they need to be compiled before debugging.
92+
- "arguments": put additional debugging arguments 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.
8793

8894
From the **Run and Debug** view, set the launch option to **Launch Program**. Then press the F5 button to start debugging.
8995

0 commit comments

Comments
 (0)