VGIT for VSI OpenVMS I64 and x86-64

Git (see https://git-scm.com/) is a widely-used distributed version control system for tracking changes in source code throughout the software development life-cycle. VGIT is partial implementation of the git version control system for VSI OpenVMS that supports a growing subset of git functionality, making it possible for the OpenVMS platform and OpenVMS application developers to participate in a heterogeneous application development environment and interact with commonly used software version control services such as GitHub and BitBucket. VGIT is used internally by VMS Software Inc., and it is anticipated that VGIT functionality will be enhanced over time, driven by user requirements.

VGIT relies upon several Open Source software packages including (but not necessarily limited to) cURL, libgit2, and OpenSSL. VSI Software Inc. would like to thank the developers and maintainers of these packages for their ongoing efforts in developing, supporting, and enhancing this software.

This version of VGIT includes minor functional improvements and has been updated to be statically linked with SSL3 instead of SSL111. Also, starting from this release, VGIT can track remote branches with uppercase characters in the name.

The kit you are receiving has been compiled, built, and tested using the operating system and product versions listed below (or comparable). Note that while you most likely will have no problems installing and using this kit on systems running higher versions of the products listed below, we do not advise using older versions.

It is assumed that the reader has a good knowledge of OpenVMS and software development in the OpenVMS environment.

Note that OpenSSL3 is statically linked with the VGIT image supplied with this kit and it is therefore not strictly necessary to have VSI SSL3 installed on the VSI OpenVMS systems on which you will be using VGIT.

It is recommended that users not familiar with Git read the materials available at https://git-scm.com/doc, as well as other documentation available on the Internet.

The kit is provided as an OpenVMS PCSI kit that can be installed by a suitably privileged user using the following command:

$ PRODUCT INSTALL VGIT

The installation will then proceed as follows (output may differ slightly from that shown depending on platform and other factors):

Performing product kit validation of signed kits ...

The following product has been selected:
    VSI I64VMS VGIT V1.4-1                 Layered Product

Do you want to continue? [NO] yes

Configuration phase starting ...

You will be asked to choose options, if any, for each selected product and for
any products that may be installed to satisfy software dependency requirements.

Configuring VSI I64VMS VGIT V1.4-1

    VMS Software Inc.

* This product does not have any configuration options.

Execution phase starting ...

The following product will be installed to destination:
    VSI I64VMS VGIT V1.4-1                 DISK$IA18_2L3:[VMS$COMMON.]

Portion done: 0%...90%...100%

The following product has been installed:
    VSI I64VMS VGIT V1.4-1                 Layered Product

VSI I64VMS VGIT V1.4-1

    Post-installation tasks are required.


    To define logical names required by the VGIT utility, add the 
    Following lines to SYS$MANAGER:SYSTARTUP_VMS.COM:

        $ file := SYS$STARTUP:VGIT$STARTUP.COM
        $ if f$search("''file'") .nes. "" then @'file'

    To deassign at system shutdown logical names used by the VGIT 
    utility, add the following lines to SYS$MANAGER:SYSHUTDWN.COM:

        $ file := SYS$STARTUP:VGIT$SHUTDOWN.COM
        $ if f$search("''file'") .nes. "" then @'file'

    To allow all users to use the VGIT utility, add the following 
    Foreign command definition to SYS$MANAGER:SYLOGIN.COM:

        $ VGIT :== $SYS$SYSTEM:VGIT2.EXE

Maxjobs:         0  Fillm:       256  Bytlm:       128000
Maxacctjobs:     0  Shrfillm:      0  Pbytlm:           0
Maxdetach:       0  BIOlm:       150  JTquota:       4096
Prclm:          50  DIOlm:       150  WSdef:         4096
Prio:            4  ASTlm:       300  WSquo:         8192
Queprio:         4  TQElm:       100  WSextent:     16384
CPU:        (none)  Enqlm:      4000  Pgflquo:     256000

The following list identifies various points that users should be aware of when using VGIT for VSI OpenVMS.

To get started, ensure that the VGIT command and the logical name GIT$SSL_CERTS are correctly defined as described in the post-installation tasks. You will then need to run the following command to set up some basic configuration details (substituting your username and email details as appropriate):

$ vgit config user -n username -e youremail

After this command completes, you should see in your login directory the file git.config, and the file should contain the details that you specified above. It is preferable to create this file before doing any operations with remote repositories in order to avoid being prompted for this information when attempting to perform some other operation. Note that the values you specify are not particularly critical and can be overridden if/when necessary; however if you will primarily be interacting with some service such as GitHub or BitBucket then you should specify your username for that service and the associated email address.

If you will need to interact via a proxy server with remote repositories hosted on services such as GitHub and BitBucket now would also be a good time to define details of your proxy server, which can be done using the following command, substituting the correct URL as necessary:

$ vgit2 config http.proxy http://myproxy.server:8080

VGIT includes some built-in documentation that can be viewed by running the program without specifying a command or specifying an invalid command. Doing this you will get the following output:

$ vgit
Usage: $1$DGA100:[SYS0.SYSCOMMON.][SYSEXE]VGIT2.EXE;1 <command> [options] [arguments]
Command summary:
        add [-s] [-v] [-u] <file> ...
        archive --format=<format> --output=<file> <commit>
        blame [-L <line-range>] [-F] [-M] [-C] [<commit-range>] <path>
        branch [[-a] | [-d <branch-name>] | [-f] <branch-name> [-t <remote>]]
        checkout [-f] [-b] [branch_name] [-- <file> ...] [-t <tag-name>] [-c <commit-id>]
        clone [-q] [-b <name>] <uri> [<path>]
        commit [-S] [-a] [-m <message> | -F <filename>]
        config user [-s global | local] [-n <username>] [-e <email>] [-p <password>]
        config http.proxy [-s global | local] <url>
        diff [-s] [-c] [-w] [-e] [-i] [<commit> <commit>] [--] [<path>...]
        fetch [-t] [<remote>]
        for-each-ref [<ref-pattern>] [--format=<format>]
        init [-b] [-q] [-s true | false | group | all | world | umask] [-t <file>] [-n (no initial commit)] [<path>]
        ls-remote <repository> [-h | -t <reference-name>]
        ls-remote --get-url <name>
        log [<options>] [<revision-range>] [-- <path>...]
        merge [-s safe | force]
        pull [-t] [r]
        push [-t | <refspec>]
        rebase [<branch>]
        remote add | set-url | rename | show
        rev-parse <name>
        rm [-b] [-s <stage>] <file>
        show-index
        show-ref
        stash [push | pop | drop | clear]
        status [-b] [-f short | long | porcelain]
        submodule init | update | add | deinit
        tag -d <tag-name> | [-s] [-f] [-m <message>] <tag-name> [<commit> | <object>]
        tag list [-l <number>] [pattern]
        reset [--soft | --mixed | --hard] [<commit>]
        verify-commit <commit>
        verify-tag <name or id>
        version

        Repositories and your login directory must be on an ODS-5 file systems
        Files must be stream-lf
        SSH requires rsa or ed25519 key

This is a basic summary of the available commands. If you want more details on a specific command, run the program specifying the command in question and supply an invalid option or leave out a required parameter. For example:

$ vgit init -h
init: illegal option -- h
Usage: init [-b] [-q] [-s true | false | group | all | world | umask] [-t <file>] [-n] [<path>]

Options:
        -b           Create a bare repository (has no working tree).
        -q           Quiet (only display errors and warnings).
        -s <value>   Repository sharing (permitted values are "true", "false", 
                     "group", "all", "world", and "umask")
        -t <file>    Specify a template directory.
        -n           Do not perform an initial commit.

Arguments:
        <path>       Directory where the repository is to be created (the directory is 
                     Created if necessary). If not specified, the current location is 
                     used.