Skip to content

Commit 1fbdb13

Browse files
updated documents for MVVS-2.5.1 release
1 parent 2d7bd09 commit 1fbdb13

8 files changed

Lines changed: 136 additions & 8 deletions

File tree

docs/img/catalog.png

17.4 KB
Loading

docs/img/catalog_compile.png

17 KB
Loading

docs/img/config_files.png

9.23 KB
Loading

docs/usage/Catalog.md

Lines changed: 95 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Catalog Settings
1+
## Catalog Settings in "db.mvbasic.json" file
22

33
Please refer to [Configuration](Configuration.md) to open the database related configuration file and then find the "catalog" section.
44

@@ -99,3 +99,97 @@ Please refer to [Configuration](Configuration.md) to open the database related c
9999
]
100100
```
101101

102+
## Quick Catalog
103+
104+
Users can right-click a BASIC program file and select "Catalog" to catalog a single file for both Universe and Unidata databases
105+
106+
![](../img/catalog.png)
107+
108+
## Catalog Settings in "catalog.mvbasic.json" file
109+
110+
Cataloging a program makes it available to all users or to users of one account. You must catalog a program before another BASIC program can call it as an external subroutine.
111+
112+
```
113+
{
114+
"catalog": "",
115+
"arguments": "",
116+
"initialCharacter": ""
117+
}
118+
```
119+
120+
### Cataloging in Universe
121+
122+
**Local Catalog**: Local cataloging creates a VOC entry for the program. This entry is a verb that points to the file and
123+
record containing the object code for the cataloged program. You can access a locally cataloged
124+
program only from the account in which it was cataloged, unless you copy the VOC entry for the
125+
catalog name to another account. Because cataloging a program locally only creates a VOC entry
126+
pointing to the object file, you need not recatalog the program every time you recompile it
127+
128+
{
129+
"catalog": "local",
130+
"arguments": "",
131+
"initialCharacter": ""
132+
}
133+
134+
**Normal Catalog**: Normal cataloging copies the specified object record to the system catalog space, making it available
135+
to all users. The name of the program in the catalog is in the following format:
136+
*account*catalog.name
137+
account is the name of the current account directory.
138+
Normal cataloging also creates a VOC entry for the catalog name. This entry is a verb that contains the
139+
name *account*catalog.name in field 2.
140+
Because normal cataloging copies the object code to the system catalog space, you must recatalog
141+
the program every time you recompile it.
142+
To catalog a program normally, specify a catalog.name that does not begin with the characters *, -, $,
143+
or !, and do not specify the keyword LOCAL.
144+
145+
{
146+
"catalog": "normal",
147+
"arguments": "",
148+
"initialCharacter": ""
149+
}
150+
151+
**Global Catalog**: Like normal cataloging, global cataloging copies the specified object record to the system catalog
152+
space, making it available to all users. The name of the program in the catalog is in the following
153+
format:
154+
*catalog.name
155+
-catalog.name
156+
$catalog.name
157+
!catalog.name
158+
Global cataloging does not create a VOC entry for the catalog name. The UniVerse command processor
159+
and the run machine look in the system catalog space for verbs or external subroutines with names
160+
that have an initial *, - , $, or ! character. Because globally cataloged subroutines are accessed without
161+
a VOC entry, they are available to all accounts on the system as soon as they are cataloged.
162+
Because global cataloging copies the object code to the system catalog space, you must recatalog the
163+
program every time you recompile it.
164+
To catalog a program globally, specify a catalog.name beginning with *, -, $, or !, and do not specify
165+
the keyword LOCAL.
166+
167+
{
168+
"catalog": "global",
169+
"arguments": "",
170+
"initialCharacter": "*"
171+
}
172+
173+
### Cataloging in Unidata
174+
175+
**Direct Catalog**: Catalogs the program locally without copying it to the local or system CTLG directory. Instead, UniData creates an entry in the VOC file that is a pointer to the directory where the program resides.
176+
177+
{
178+
"catalog": "direct",
179+
"arguments": "",
180+
"initialCharacter": ""
181+
}
182+
183+
**Local Catalog**: Catalogs the program locally and places a copy of it in a subdirectory of the local CTLG catalog (in the account where the user is running the program). UniData creates a VOC pointer to the subdirectory.UniData creates the CTLG and the subdirectory, if they do not
184+
already exist.
185+
186+
{
187+
"catalog": "local",
188+
"arguments": "",
189+
"initialCharacter": ""
190+
}
191+
192+
193+
**Note 1 :** The parameter "arguments" in the catalog.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.
194+
195+
**Note 2 :** If the `./rmv` configuration exists, the `catalog.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/catalog.mvbasic.json` file will be created when the extension is activated.

docs/usage/Configuration.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Press <kbd>F1</kbd> to open the command window and then enter the "*Edit Configu
66

77
There are three configuration files: "Database and BASIC Related Configuration", "Formatting Configuration" and "Group View Configuration".
88

9-
![](../img/configuration_files.png)
9+
![](../img/config_files.png)
1010

1111
If there are multiple workspace folders, you can select the folder to edit. Configuration files in different workspace folders have no relationship or dependency.
1212

@@ -22,7 +22,7 @@ Following relevant configurations are included:
2222

2323
- Additional accounts. See [accounts settings](./Accounts.md) for more information.
2424

25-
- Catalog programs configuration. See [catalog settings](./Catalog.md) for more information.
25+
- Catalog programs configuration. See [Catalog Settings in "db.mvbasic.json" file](./Catalog.md) for more information.
2626

2727
- Include files configuration. See [include settings](./Include.md) for more information.
2828

@@ -38,6 +38,14 @@ The configuration file name is "groupView.mvbasic.json".
3838

3939
This configuration file contains the settings for feature Group View. If you need change the group view behaviors, please update the settings in this file. See [group view settings](./GroupView.md) for more information.
4040

41+
## Catalog Configuration
42+
43+
The configuration file name is "catalog.mvbasic.json".
44+
45+
This configuration file contains the parameters for the Catalog feature. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "catalog.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
46+
47+
**Note:** If either `./rmv` or `./rmvonline` configuration exists, the `catalog.mvbasic.json` file will be created during the first catalog attempt. If the `./rmv` configuration does not exist, the `config/catalog.mvbasic.json` file will be created when the extension is activated.
48+
4149
## Configuration Files
4250

4351
There are also user level configuration files in the user profile. When you want to apply some settings to all projects of the current user, you can modify the user-level configuration files.

docs/usage/GaraSign.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,32 @@ openssl dgst -verify <public key file> -signature <signature> <file to verify>
1010

1111
### Below is detailed information on how to execute the verify command:
1212

13-
1. Extract the **signature file** and **public key** files from the **'rocket-mvbasic-2.5.0-garasign.zip'** zip file.
13+
1. Extract the **signature file** and **public key** files from the **'rocket-mvbasic-2.5.1_sign.zip'** zip file.
1414

15-
2. Unzip the **'rocket-mvbasic-2.5.0-garasign.zip'** zip file and execute the command below for verification:
15+
2. Unzip the **'rocket-mvbasic-2.5.1_sign.zip'** zip file and execute the commands below for verification:
1616

1717
```bash
18-
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.0.vsix.sig rocket-mvbasic-2.5.0.vsix
18+
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.1.vsix.sig rocket-mvbasic-2.5.1.vsix
19+
20+
Verified OK
21+
```
22+
23+
```bash
24+
openssl dgst -verify rocket_mv.pem.pub.key -signature uvdap-uv1421-linux.tar.gz.sig uvdap-uv1421-linux.tar.gz
25+
26+
Verified OK
27+
```
28+
29+
```bash
30+
openssl dgst -verify rocket_mv.pem.pub.key -signature uvdap-uv1421-windows.zip.sig uvdap-uv1421-windows.zip
1931
2032
Verified OK
2133
```
2234

2335
3. Failed use cases:
2436

2537
```bash
26-
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.0.vsix.sig rocket-mvbasic-2.5.0.vsix
38+
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.1.vsix.sig rocket-mvbasic-2.5.1.vsix
2739
2840
Verification Failure
2941
```

docs/usage/KnownIssues.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@
9292

9393
**MVVS-1314** delete currently connected server should also disconnect from current connection in online editing mode.
9494

95+
## Catalog
96+
97+
**MVVS-1385** The "arguments" parameter in catalog.mvbasic.json is not supported, defaulting to FORCE for UV and UD databases.
9598

9699
## Others
97100

docs/usage/OnlineEditing.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,17 @@ Before using the compilation or catalog functions, a U2 database account must al
116116
#### Quick compile
117117
Users can right-click a BASIC program file and select “” to compile a single file.
118118

119-
![](../img/online_editing_compile_1.png)
119+
![](../img/catalog_compile.png)
120120

121121
For UniData, there are multiple compilation commands for different flavors.
122122

123+
#### Quick catalog
124+
Users can right-click a BASIC program file and select "Catalog" to catalog a single file for both Universe and Unidata databases
125+
126+
![](../img/catalog.png)
127+
128+
Clicking on 'Catalog' will use the parameters from the catalog.mvbasic.json file to catalog the file. If you need to change the catalog type, arguments, or initial character, please update the settings in this file. See [Catalog Settings in "catalog.mvbasic.json" file](./Catalog.md#quick-catalog) for more information.
129+
123130
#### Compile / Catalog with configuration file
124131
The configuration file can help a user to compile and catalog multiple files.
125132
Select “Configure Default Build Task…” from the Terminal menu, and then select “BASIC: Online Editing build” to create a build task.
@@ -142,3 +149,7 @@ Most of the LSP (Language Server Protocol) features are supported, but there are
142149
- Custom documentation features are also not supported now.
143150

144151
- Please note that only one instance of VS Code can be run at a time.
152+
153+
- Do not click on another account's folder before completing the cataloging of the current BASIC program. Doing so may result in cataloging the wrong BASIC program on the U2 server side.
154+
155+
- The parameter "arguments" in the catalog.mvbasic.json file is currently not supported by the catalog feature. By default, the argument is set to FORCE for both the UV and UD databases.

0 commit comments

Comments
 (0)