Skip to content

Commit

Permalink
updated documents for MVVS-2.5.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
sgaikwad-rocket committed Aug 23, 2024
1 parent 2d7bd09 commit 1fbdb13
Show file tree
Hide file tree
Showing 8 changed files with 136 additions and 8 deletions.
Binary file added docs/img/catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/catalog_compile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/config_files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
96 changes: 95 additions & 1 deletion docs/usage/Catalog.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Catalog Settings
## Catalog Settings in "db.mvbasic.json" file

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

Expand Down Expand Up @@ -99,3 +99,97 @@ Please refer to [Configuration](Configuration.md) to open the database related c
]
```

## Quick Catalog

Users can right-click a BASIC program file and select "Catalog" to catalog a single file for both Universe and Unidata databases

![](../img/catalog.png)

## Catalog Settings in "catalog.mvbasic.json" file

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.

```
{
"catalog": "",
"arguments": "",
"initialCharacter": ""
}
```

### Cataloging in Universe

**Local Catalog**: Local cataloging creates a VOC entry for the program. This entry is a verb that points to the file and
record containing the object code for the cataloged program. You can access a locally cataloged
program only from the account in which it was cataloged, unless you copy the VOC entry for the
catalog name to another account. Because cataloging a program locally only creates a VOC entry
pointing to the object file, you need not recatalog the program every time you recompile it

{
"catalog": "local",
"arguments": "",
"initialCharacter": ""
}

**Normal Catalog**: Normal cataloging copies the specified object record to the system catalog space, making it available
to all users. The name of the program in the catalog is in the following format:
*account*catalog.name
account is the name of the current account directory.
Normal cataloging also creates a VOC entry for the catalog name. This entry is a verb that contains the
name *account*catalog.name in field 2.
Because normal cataloging copies the object code to the system catalog space, you must recatalog
the program every time you recompile it.
To catalog a program normally, specify a catalog.name that does not begin with the characters *, -, $,
or !, and do not specify the keyword LOCAL.

{
"catalog": "normal",
"arguments": "",
"initialCharacter": ""
}

**Global Catalog**: Like normal cataloging, global cataloging copies the specified object record to the system catalog
space, making it available to all users. The name of the program in the catalog is in the following
format:
*catalog.name
-catalog.name
$catalog.name
!catalog.name
Global cataloging does not create a VOC entry for the catalog name. The UniVerse command processor
and the run machine look in the system catalog space for verbs or external subroutines with names
that have an initial *, - , $, or ! character. Because globally cataloged subroutines are accessed without
a VOC entry, they are available to all accounts on the system as soon as they are cataloged.
Because global cataloging copies the object code to the system catalog space, you must recatalog the
program every time you recompile it.
To catalog a program globally, specify a catalog.name beginning with *, -, $, or !, and do not specify
the keyword LOCAL.

{
"catalog": "global",
"arguments": "",
"initialCharacter": "*"
}

### Cataloging in Unidata

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

{
"catalog": "direct",
"arguments": "",
"initialCharacter": ""
}

**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
already exist.

{
"catalog": "local",
"arguments": "",
"initialCharacter": ""
}


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

**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.
12 changes: 10 additions & 2 deletions docs/usage/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Press <kbd>F1</kbd> to open the command window and then enter the "*Edit Configu

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

![](../img/configuration_files.png)
![](../img/config_files.png)

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

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

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

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

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

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

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.

## Catalog Configuration

The configuration file name is "catalog.mvbasic.json".

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.

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

## Configuration Files

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.
Expand Down
20 changes: 16 additions & 4 deletions docs/usage/GaraSign.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,32 @@ openssl dgst -verify <public key file> -signature <signature> <file to verify>

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

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

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

```bash
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.0.vsix.sig rocket-mvbasic-2.5.0.vsix
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.1.vsix.sig rocket-mvbasic-2.5.1.vsix

Verified OK
```

```bash
openssl dgst -verify rocket_mv.pem.pub.key -signature uvdap-uv1421-linux.tar.gz.sig uvdap-uv1421-linux.tar.gz
Verified OK
```

```bash
openssl dgst -verify rocket_mv.pem.pub.key -signature uvdap-uv1421-windows.zip.sig uvdap-uv1421-windows.zip
Verified OK
```

3. Failed use cases:

```bash
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.0.vsix.sig rocket-mvbasic-2.5.0.vsix
openssl dgst -verify rocket_mv.pem.pub.key -signature rocket-mvbasic-2.5.1.vsix.sig rocket-mvbasic-2.5.1.vsix
Verification Failure
```
3 changes: 3 additions & 0 deletions docs/usage/KnownIssues.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@

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

## Catalog

**MVVS-1385** The "arguments" parameter in catalog.mvbasic.json is not supported, defaulting to FORCE for UV and UD databases.

## Others

Expand Down
13 changes: 12 additions & 1 deletion docs/usage/OnlineEditing.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,17 @@ Before using the compilation or catalog functions, a U2 database account must al
#### Quick compile
Users can right-click a BASIC program file and select “” to compile a single file.

![](../img/online_editing_compile_1.png)
![](../img/catalog_compile.png)

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

#### Quick catalog
Users can right-click a BASIC program file and select "Catalog" to catalog a single file for both Universe and Unidata databases

![](../img/catalog.png)

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.

#### Compile / Catalog with configuration file
The configuration file can help a user to compile and catalog multiple files.
Select “Configure Default Build Task…” from the Terminal menu, and then select “BASIC: Online Editing build” to create a build task.
Expand All @@ -142,3 +149,7 @@ Most of the LSP (Language Server Protocol) features are supported, but there are
- Custom documentation features are also not supported now.

- Please note that only one instance of VS Code can be run at a time.

- 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.

- 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 comments on commit 1fbdb13

Please sign in to comment.