Git Implementation Class Documentation
This document was created by the PetranWay Autodocumentation Utility.
Empty
C:\PetranWay\Reuse Development\LabVIEW_Git\Implementation\Git Implementation.lvclass
See the Class Report Design for an explanation of data name and type syntax.
| Name | Description | Data Type |
|---|---|---|
| Git Application | String | |
| Top Directory | Path | |
| Merge-Delegate | LabVIEW Class of type "Merge-Delegate" |
| Member Name | Scope | Dynamic Dispatch | Must Override | Must Use Parent Implementation | Description \ Prototype |
|---|---|---|---|---|---|
| CMD Return | community | FALSE | FALSE | FALSE |  |
| Execute Command | community | FALSE | FALSE | FALSE |  |
| Add | public | FALSE | FALSE | FALSE |  |
| Add specific files from the working tree to the index (stage the files). This operation prepares the index for an upcoming Commit operation. | |||||
| Clone | public | FALSE | FALSE | FALSE |  |
| Clone a repository from the Remote URL. The repository will be cloned into the directory specified as the Target Directory, which should be either nonexistent or empty. Do not use the Status Message as a parseable output - it is for user information/display only and may change between versions. | |||||
| Commit | public | FALSE | FALSE | FALSE |  |
| Create a new commit containing the current contents of the index. | |||||
| Fetch | public | FALSE | FALSE | FALSE |  |
| Fetches (updates) a repository from the remote by name or URL. When no name is specified, the default remote will be used (this is often called "origin"). Do not use the Status Message as a parseable output - it is for user information/display only and may change between versions. | |||||
| Merge | public | FALSE | FALSE | FALSE |  |
| Carry out a "git merge" operation using the behaviour of the Merge-Delegate class contained within this class' private data. By default, a "No-Conflicts" Merge Delegate is used. Git merge is the second half of a "git pull" operation. | |||||
| Push | public | FALSE | FALSE | FALSE |  |
| Updates remote refs using local refs, while sending objects necessary to complete the given refs. Repository can be the name of a remote (e.g. "origin") or a URL. If it is empty, then the value is taken from the configuration for the local repository (via branch.*.remote). If no configuration exists, then "origin" is used). | |||||
| Reset | public | FALSE | FALSE | FALSE |  |
| Reset the state of the repository based on the Reset Mode and the current state. Hard will modify the local directory to match the Target. Soft will not modify the local directory, but will update HEAD. Mixed will move the HEAD to the Target, and update the index, but will not change the local directory contents. Alternatively files can be specified to be reset - in this case, the file copies will be copied from Target to the index (what would be commited if a 'Git Commit' immediately followed). | |||||
| Status | public | FALSE | FALSE | FALSE |  |
| Show the working tree status. From git-scm.com/docs/git-status: Displays paths that have differences between the index file and the current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not tracked by Git (and are not ignored by gitignore). The first are what you would commit by running git commit; the second and third are what you could commit by running git add before running git commit. | |||||
| Tag | public | FALSE | FALSE | FALSE |  |
| Create, list, delete or verify the signature of a tag object. By default, use this VI to create annotated tags that can be pushed using Push together with the tags option. A signed tag requires a GnuPG key associated with your committer identity, found via your git-configuration. See https://git-scm.com/docs/git-tag for further details. | |||||
| Message to Message Option | private | FALSE | FALSE | FALSE |  |
| Parse Push Refspecs | private | FALSE | FALSE | FALSE |  |
| Upstream Error Message | private | FALSE | FALSE | FALSE |  |
| Provide a message for the Error case in API operations, when the operation receives an error on the input wire. | |||||
| Format Paths | protected | TRUE | FALSE | FALSE |  |
| Converts an array of paths to a string that can be used to provide a "pathspec" element for Git commands. | |||||
| Add Options | public | FALSE | FALSE | FALSE |  |
| Set of implemented options for the Git Add operation. These settings will not force a configured true option in your gitconfig to be set false - they can only be used to force an option to be used (not not used). All: "--all". Add, modify or remove index entries as needed to match the working tree. Force: "--force". Allow adding ignored files. Intent Only: "--intent-to-add". Don't stage the file - just add an empty object to the index at this path. The path must exist! Continue on Error: "--ignore-errors". Don't abort if an error occurs indexing files. Continue through the full list of files. The return value will still be non-zero if this occurs. | |||||
| Force Mode | public | FALSE | FALSE | FALSE |  |
| Output Type | public | FALSE | FALSE | FALSE |  |
| Push Options | public | FALSE | FALSE | FALSE |  |
| Reset Mode | public | FALSE | FALSE | FALSE |  |
| Tag Operation | public | FALSE | FALSE | FALSE |  |
| Set Git Application | public | FALSE | FALSE | FALSE |  |