The legit Reference Manual

Table of Contents

The legit Reference Manual

This is the legit Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 11:22:57 2021 GMT+0.

1 Introduction

About Legit

This is an interface to the GIT binary to make controlling it from within CL much easier. I've had the need to do this kind of thing a couple of times now, so I might as well encapsulate it into a proper library. I don't know if this is ever going to reach full coverage of all features given GIT's immense size, but I will add features as they are needed. The low-level command API is fully mapped however.

How To

You will need the git binary in your PATH. Once you got that, and have this system loaded via ASDF or Quicklisp, you can access all the git commands through functions.

(legit:with-chdir ("some/git/dir")
  (legit:git-rev-parse "HEAD" :short T))

All commands have been hand-rewritten to work through the uniform and comfortable API we're used to from Lisp. There is an even more convenient (albeit incomplete) interface using repository instances.

(let ((repository (make-instance 'legit:repository :location "some/git/dir")))
  (values (legit:commits repository)
          (legit:current-branch repository)
          (legit:remote-url repository)))

A lot of the information about a repository that you can access will automatically be cached until some destructive operation (like a pull) occurs, so that querying that information does not take so much time each request.

Also See

• Simple-inferiors for running and controlling the git binary.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 legit

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/legit/

Source Control

(:git "https://github.com/shinmera/legit.git")

Bug Tracker

https://github.com/Shinmera/legit/issues

License

zlib

Description

CL interface to the GIT binary.

Version

1.0.0

Dependencies

• uiop
• simple-inferiors
• lambda-fiddle
• cl-ppcre
• documentation-utils

Source

legit.asd (file)

Components

• package.lisp (file)
• toolkit.lisp (file)
• process.lisp (file)
• low-level.lisp (file)
• repository.lisp (file)
• documentation.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 legit.asd

Location

legit.asd

Systems

legit (system)

3.1.2 legit/package.lisp

Parent

legit (system)

Location

package.lisp

Packages

legit

3.1.3 legit/toolkit.lisp

Dependency

package.lisp (file)

Parent

legit (system)

Location

toolkit.lisp

Exported Definitions

relative-dir (function)

Internal Definitions

• %opt (macro)
• *unix-epoch-difference* (special variable)
• argetypecase (macro)
• define-argparser (macro)
• define-git-wrapper (macro)
• ensure-list (function)
• front-arg-p (function)
• minimal-shell-namestring (function)
• p-symb (function)
• parse-kargdef (function)
• parse-oargdef (function)
• parse-rargdef (function)
• purify-args (function)
• shellify (function)
• universal-to-unix-time (function)
• unix-to-universal-time (function)

3.1.4 legit/process.lisp

Dependency

toolkit.lisp (file)

Parent

legit (system)

Location

process.lisp

Exported Definitions

• *git-errors* (special variable)
• *git-input* (special variable)
• *git-output* (special variable)
• git-error (condition)
• run-git (function)

Internal Definitions

• %resolve-stream (function)
• coerce-to-cmdarg (function)
• flatten (function)

3.1.5 legit/low-level.lisp

Dependency

process.lisp (file)

Parent

legit (system)

Location

low-level.lisp

Exported Definitions

• git-add (function)
• git-am (function)
• git-apply (function)
• git-archive (function)
• git-bisect (function)
• git-blame (function)
• git-branch (function)
• git-bundle (function)
• git-cat-file (function)
• git-checkout (function)
• git-cherry-pick (function)
• git-clean (function)
• git-clone (function)
• git-commit (function)
• git-commit-tree (function)
• git-config (function)
• git-count-objects (function)
• git-daemon (function)
• git-describe (function)
• git-diff (function)
• git-diff-index (function)
• git-fast-import (function)
• git-fetch (function)
• git-filter-branch (function)
• git-for-each-ref (function)
• git-format-patch (function)
• git-fsck (function)
• git-gc (function)
• git-grep (function)
• git-hash-object (function)
• git-help (function)
• git-init (function)
• git-instaweb (function)
• git-log (function)
• git-ls-files (function)
• git-merge (function)
• git-merge-base (function)
• git-mergetool (function)
• git-mv (function)
• git-pull (function)
• git-push (function)
• git-read-tree (function)
• git-rebase (function)
• git-reflog (function)
• git-remote (function)
• git-request-pull (function)
• git-reset (function)
• git-rev-list (function)
• git-rev-parse (function)
• git-revert (function)
• git-rm (function)
• git-shortlog (function)
• git-show (function)
• git-show-ref (function)
• git-stash (function)
• git-status (function)
• git-submodule (function)
• git-svn (function)
• git-symbolic-ref (function)
• git-tag (function)
• git-update-index (function)
• git-update-ref (function)
• git-update-server-info (function)
• git-verify-pack (function)
• git-write-tree (function)

Internal Definitions

git-send-email (function)

3.1.6 legit/repository.lisp

Dependency

low-level.lisp (file)

Parent

legit (system)

Location

repository.lisp

Exported Definitions

• add (generic function)
• add (method)
• add (method)
• add (method)
• bare-p (generic function)
• bare-p (method)
• bare-p (method)
• bare-p (method)
• checkout (generic function)
• checkout (method)
• checkout (method)
• checkout (method)
• clean (generic function)
• clean (method)
• clean (method)
• clean (method)
• clear-cache (generic function)
• clear-cache (method)
• clear-cache (method)
• clear-cache (method)
• clone (generic function)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• commit (generic function)
• commit (method)
• commit (method)
• commit (method)
• commit-age (generic function)
• commit-age (method)
• commit-age (method)
• commit-age (method)
• commit-author (generic function)
• commit-author (method)
• commit-author (method)
• commit-author (method)
• commit-message (generic function)
• commit-message (method)
• commit-message (method)
• commit-message (method)
• commits (generic function)
• commits (method)
• commits (method)
• commits (method)
• current-age (generic function)
• current-age (method)
• current-age (method)
• current-age (method)
• current-branch (generic function)
• current-branch (method)
• current-branch (method)
• current-branch (method)
• current-commit (generic function)
• current-commit (method)
• current-commit (method)
• current-commit (method)
• current-message (generic function)
• current-message (method)
• current-message (method)
• current-message (method)
• do-submodules (macro)
• fetch (generic function)
• fetch (method)
• fetch (method)
• fetch (method)
• git-location-p (function)
• git-value (macro)
• init (generic function)
• init (method)
• init (method)
• init (method)
• map-submodules (generic function)
• map-submodules (method)
• map-submodules (method)
• map-submodules (method)
• pull (generic function)
• pull (method)
• pull (method)
• pull (method)
• push (generic function)
• push (method)
• push (method)
• push (method)
• remote-url (generic function)
• remote-url (method)
• remote-url (method)
• remote-url (method)
• (setf remotes) (function)
• remotes (generic function)
• remotes (method)
• remotes (method)
• remotes (method)
• (setf remotes) (function)
• repository (class)
• reset (generic function)
• reset (method)
• reset (method)
• reset (method)
• submodules (generic function)
• submodules (method)
• submodules (method)
• submodules (method)

Internal Definitions

• cache (method)
• (setf cache) (method)
• define-repo-function (macro)
• handle-init (function)
• set-remotes (generic function)
• set-remotes (method)
• set-remotes (method)
• set-remotes (method)

3.1.7 legit/documentation.lisp

Dependency

repository.lisp (file)

Parent

legit (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 legit

Source

package.lisp (file)

Nickname

org.shirakumo.legit

Use List

• simple-inferiors
• common-lisp

Exported Definitions

• *git-errors* (special variable)
• *git-input* (special variable)
• *git-output* (special variable)
• add (generic function)
• add (method)
• add (method)
• add (method)
• bare-p (generic function)
• bare-p (method)
• bare-p (method)
• bare-p (method)
• checkout (generic function)
• checkout (method)
• checkout (method)
• checkout (method)
• clean (generic function)
• clean (method)
• clean (method)
• clean (method)
• clear-cache (generic function)
• clear-cache (method)
• clear-cache (method)
• clear-cache (method)
• clone (generic function)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• clone (method)
• commit (generic function)
• commit (method)
• commit (method)
• commit (method)
• commit-age (generic function)
• commit-age (method)
• commit-age (method)
• commit-age (method)
• commit-author (generic function)
• commit-author (method)
• commit-author (method)
• commit-author (method)
• commit-message (generic function)
• commit-message (method)
• commit-message (method)
• commit-message (method)
• commits (generic function)
• commits (method)
• commits (method)
• commits (method)
• current-age (generic function)
• current-age (method)
• current-age (method)
• current-age (method)
• current-branch (generic function)
• current-branch (method)
• current-branch (method)
• current-branch (method)
• current-commit (generic function)
• current-commit (method)
• current-commit (method)
• current-commit (method)
• current-message (generic function)
• current-message (method)
• current-message (method)
• current-message (method)
• do-submodules (macro)
• fetch (generic function)
• fetch (method)
• fetch (method)
• fetch (method)
• git-add (function)
• git-am (function)
• git-apply (function)
• git-archive (function)
• git-bisect (function)
• git-blame (function)
• git-branch (function)
• git-bundle (function)
• git-cat-file (function)
• git-checkout (function)
• git-cherry-pick (function)
• git-clean (function)
• git-clone (function)
• git-commit (function)
• git-commit-tree (function)
• git-config (function)
• git-count-objects (function)
• git-daemon (function)
• git-describe (function)
• git-diff (function)
• git-diff-index (function)
• git-error (condition)
• git-fast-import (function)
• git-fetch (function)
• git-filter-branch (function)
• git-for-each-ref (function)
• git-format-patch (function)
• git-fsck (function)
• git-gc (function)
• git-grep (function)
• git-hash-object (function)
• git-help (function)
• git-init (function)
• git-instaweb (function)
• git-location-p (function)
• git-log (function)
• git-ls-files (function)
• git-merge (function)
• git-merge-base (function)
• git-mergetool (function)
• git-mv (function)
• git-pull (function)
• git-push (function)
• git-read-tree (function)
• git-rebase (function)
• git-reflog (function)
• git-remote (function)
• git-request-pull (function)
• git-reset (function)
• git-rev-list (function)
• git-rev-parse (function)
• git-revert (function)
• git-rm (function)
• git-shortlog (function)
• git-show (function)
• git-show-ref (function)
• git-stash (function)
• git-status (function)
• git-submodule (function)
• git-svn (function)
• git-symbolic-ref (function)
• git-tag (function)
• git-update-index (function)
• git-update-ref (function)
• git-update-server-info (function)
• git-value (macro)
• git-verify-pack (function)
• git-write-tree (function)
• init (generic function)
• init (method)
• init (method)
• init (method)
• map-submodules (generic function)
• map-submodules (method)
• map-submodules (method)
• map-submodules (method)
• pull (generic function)
• pull (method)
• pull (method)
• pull (method)
• push (generic function)
• push (method)
• push (method)
• push (method)
• relative-dir (function)
• remote-url (generic function)
• remote-url (method)
• remote-url (method)
• remote-url (method)
• (setf remotes) (function)
• remotes (generic function)
• remotes (method)
• remotes (method)
• remotes (method)
• (setf remotes) (function)
• repository (class)
• reset (generic function)
• reset (method)
• reset (method)
• reset (method)
• run-git (function)
• submodules (generic function)
• submodules (method)
• submodules (method)
• submodules (method)

Internal Definitions

• %opt (macro)
• %resolve-stream (function)
• *unix-epoch-difference* (special variable)
• argetypecase (macro)
• cache (generic function)
• cache (method)
• (setf cache) (method)
• (setf cache) (generic function)
• coerce-to-cmdarg (function)
• define-argparser (macro)
• define-git-wrapper (macro)
• define-repo-function (macro)
• ensure-list (function)
• flatten (function)
• front-arg-p (function)
• git-send-email (function)
• handle-init (function)
• minimal-shell-namestring (function)
• p-symb (function)
• parse-kargdef (function)
• parse-oargdef (function)
• parse-rargdef (function)
• purify-args (function)
• set-remotes (generic function)
• set-remotes (method)
• set-remotes (method)
• set-remotes (method)
• shellify (function)
• universal-to-unix-time (function)
• unix-to-universal-time (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *git-errors*

The stream to which the error output of the git process is sent.

Defaults to T, but may be automatically bound by some functions in order to process the output.

Package

legit

Source

process.lisp (file)

Special Variable: *git-input*

The stream from which the standard input of the git process is taken.

Defaults to NIL.

Package

legit

Source

process.lisp (file)

Special Variable: *git-output*

The stream to which the standard output of the git process is sent.

Defaults to T, but may be automatically bound by some functions in order to process the output.

Package

legit

Source

process.lisp (file)

5.1.2 Macros

Macro: do-submodules (SUBMODULE REPOSITORY &rest ARGS) &body BODY

Iterates over all submodules of REPOSITORY.

See MAP-SUBMODULES
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Macro: git-value REPOSITORY NAME &body FORMS

Shorthand macro to handle caching of the value from the git process under NAME.

Package

legit

Source

repository.lisp (file)

5.1.3 Functions

Function: git-add &key PATHS DRY-RUN VERBOSE FORCE INTERACTIVE PATCH EDIT UPDATE ALL IGNORE-REMOVAL INTENT-TO-ADD REFRESH IGNORE-ERRORS IGNORE-MISSING

git add

See https://git-scm.com/docs/git-add

Package

legit

Source

low-level.lisp (file)

Function: git-am &key MAILDIRS SIGNOFF KEEP KEEP-NON-PATCH KEEP-CR SCISSORS MESSAGE-ID QUIET UTF8 3WAY IGNORE-SPACE-CHANGE IGNORE-WHITESPACE WHITESPACE DIRECTORY EXCLUDE INCLUDE REJECT PATCH-FORMAT INTERACTIVE COMMITER-DATE-IS-AUTHOR-DATE IGNORE-DATE SKIP GPG-SIGN CONTINUE RESOLVED RESOLVEMSG ABORT REMOVE-LEADING-SLASHES SURROUNDING

git am

See https://git-scm.com/docs/git-am

Package

legit

Source

low-level.lisp (file)

Function: git-apply &key PATCHES STAT NUMSTAT SUMMARY CHECK INDEX CACHED 3WAY BUILD-FAKE-ANCESTOR RECURSIVE REJECT MACHINE-READABLE REMOVE-LEADING-SLASHES SURROUNDING UNIDIFF-ZERO APPLY NO-ADD BINARY EXCLUDE INCLUDE IGNORE-WHITESPACE WHITESPACE INACCURATE-EOF VERBOSE RECOUNT DIRECTORY UNSAFE-PATHS

git apply

See https://git-scm.com/docs/git-apply

Package

legit

Source

low-level.lisp (file)

Function: git-archive TREE-ISH &key PATHS FORMAT LIST VERBOSE PREFIX OUTPUT WORKTREE-ATTRIBUTES REMOTE EXEC

git archive

See https://git-scm.com/docs/git-archive

Package

legit

Source

low-level.lisp (file)

Function: git-bisect ACTION &key OPTIONS PATHS NO-CHECKOUT

git bisect

See https://git-scm.com/docs/git-bisect

Package

legit

Source

low-level.lisp (file)

Function: git-blame FILE &key BLANK ROOT SHOW-STATS RANGE LONG TIMESTAMP REVISIONS REVERSE PORCELAIN LINE-PORCELAIN INCREMENTAL ENCODING CONTENTS DATE MOVED WITHIN-COMMIT HELP ANNOTATE SCORE-DEBUG SHOW-NAME SHOW-NUMBER SUPPRESS SHOW-EMAIL IGNORE-WHITESPACE ABBREV

git blame

See https://git-scm.com/docs/git-blame

Package

legit

Source

low-level.lisp (file)

Function: git-branch &key BRANCH START-POINT OLD-BRANCH NEW-BRANCH PATTERNS BRANCHES DELETE CREATE-REFLOG FORCE MOVE COLOR COLUMN REMOTES ALL LIST VERBOSE QUIET ABBREV TRACK SET-UPSTREAM SET-UPSTREAM-TO UNSET-UPSTREAM EDIT-DESCRIPTION CONTAINS MERGED NO-MERGED

git branch

See https://git-scm.com/docs/git-branch

Package

legit

Source

low-level.lisp (file)

Function: git-bundle ACTION FILE &key GIT-REV-LIST-ARGS REFNAMES

git bundle

See https://git-scm.com/docs/git-bundle

Package

legit

Source

low-level.lisp (file)

Function: git-cat-file OBJECT &key TYPE SHOW-TYPE SHOW-SIZE SUPPRESS PRETTY TEXTCONV BATCH BATCH-CHECK ALLOW-UNKNOWN-TYPE FOLLOW-SYMLINKS

git cat-file

See https://git-scm.com/docs/git-cat-file

Package

legit

Source

low-level.lisp (file)

Function: git-checkout &key BRANCH NEW-BRANCH START-POINT TREE-ISH COMMIT PATHS QUIET FORCE OURS THEIRS TRACK DETACH ORPHAN IGNORE-SKIP-WORKTREE-BITS MERGE CNOFLICT PATH IGNORE-OTHER-WORKTREES

git checkout

See https://git-scm.com/docs/git-checkout

Package

legit

Source

low-level.lisp (file)

Function: git-cherry-pick &key COMMITS EDIT CONTINUE QUIT ABORT APPEND-NOTICE MAINLINE NO-COMMIT SIGNOFF GPG-SIGN FF ALLOW-EMPTY ALLOW-EMPTY-MESSAGE KEEP-REDUNDANT-COMMITS STRATEGY STRATEGY-OPTION

git cherry-pick

See https://git-scm.com/docs/git-cherry-pick

Package

legit

Source

low-level.lisp (file)

Function: git-clean &key PATHS DIRECTORIES FORCE INTERACTIVE DRY-RUN QUIET EXCLUDE NO-IGNORE REMOVE-IGNORED

git clean

See https://git-scm.com/docs/git-clean

Package

legit

Source

low-level.lisp (file)

Function: git-clone REPOSITORY &key DIRECTORY LOCAL NO-HARDLINKS SHARED REFERENCE DISSOCIATE QUIET VERBOSE PROGRESS NO-CHECKOUT BARE MIRROR ORIGIN BRANCH UPLOAD-PACK TEMPLATE CONFIG DEPTH SINGLE-BRANCH RECURSIVE SEPARATE-GIT-DIR

git clone

See https://git-scm.com/docs/git-clone

Package

legit

Source

low-level.lisp (file)

Function: git-commit &key FILES ALL PATCH REUSE-MESSAGE REEDIT-MESSAGE FIXUP SQUASH RESET-AUTHOR SHORT BRANCH PORCELAIN LONG NULL FILE AUTHOR DATE MESSAGE TEMPLATE SIGNOFF NO-VERIFY ALLOW-EMPTY ALLOW-EMPTY-MESSAGE CLEANUP EDIT AMEND NO-POST-REWRITE INCLUDE ONLY UNTRACKED-FILES VERBOSE QUIET DRY-RUN STATUS GPG-SIGN

git commit

See https://git-scm.com/docs/git-commit

Package

legit

Source

low-level.lisp (file)

Function: git-commit-tree TREE &key PARENT MESSAGE FILE GPG-SIGN

git commit-tree

See https://git-scm.com/docs/git-commit-tree

Package

legit

Source

low-level.lisp (file)

Function: git-config &key FILE-OPTION TYPE NAME VALUE URL NAME-REGEX VALUE-REGEX OLD-NAME NEW-NAME DEFAULT STDOUT-IS-TTY NULL ADD REPLACE-ALL UNSET UNSET-ALL RENAME-SECTION REMOVE-SECTION LIST GET-COLOR GET-COLORBOOL EDIT

git config

See https://git-scm.com/docs/git-config

Package

legit

Source

low-level.lisp (file)

Function: git-count-objects &key VERBOSE HUMAN-READABLE

git count-objects

See https://git-scm.com/docs/git-count-objects

Package

legit

Source

low-level.lisp (file)

Function: git-daemon &key DIRECTORY STRICT-PATHS BASE-PATH BASE-PATH-RELAXED INTERPOLATED-PATH EXPORT-ALL INTED LISTEN PORT INIT-TIMEOUT TIMEOUT MAX-CONNECTIONS SYSLOG USER-PATH VERBOSE REUSEADDR DETACH PID-FILE USER GROUP ENABLE DISABLE ALLOW-OVERRIDE FORBID-OVERRIF INFORMATIVE-ERRORS ACCESS-HOOK

git daemon

See https://git-scm.com/docs/git-daemon

Package

legit

Source

low-level.lisp (file)

Function: git-describe &key COMMIT-ISHS DIRTY ALL TAGS CONTAINS ABBREV CANDIDATES EXACT-MATCH DEBUG LONG MATCH ALWAYS FIRST-PARENT

git describe

See https://git-scm.com/docs/git-describe

Package

legit

Source

low-level.lisp (file)

Function: git-diff &key COMMIT BLOB PATHS PATCH UNIFIED RAW PATCH-WITH-RAW MINIMAL PATIENCE HISTOGRAM DIFF-ALGORITHM STAT NUMSTAT SHORTSTAT DIRSTAT SUMMARY PATCH-WITH-STAT NULL NAME-ONLY NAME-STATUS SUBMODULE COLOR WORD-DIFF WORD-DIFF-REGEX COLOR-WORDS NO-RENAMES CHECK WS-ERROR-HIGHLIGHT FULL-INDEX BINARY ABBREV BREAK-REWRITES FIND-RENAMES FIND-COPIES FIND-COPIES-HARDER IRREVERSIBLE-DELETE LIMIT-FIND DIFF-FILTER DIFFERING-OCCURRENCES DIFFERING-DIFFS PICKAXE-ALL PICKAXE-REGEX ORDER SWAP RELATIVE TEXT IGNORE-SPACE-AT-EOL IGNORE-SPACE-CHANGE IGNORE-ALL-SPACE IGNORE-BLANK-LINES INTER-HUNK-CONTEXT FUNCTION-CONTEXT EXT-DIFF TEXTCONV IGNORE-SUBMODULES SRC-PREFIX DST-PREFIX NO-PREFIX

git diff

See https://git-scm.com/docs/git-diff

Package

legit

Source

low-level.lisp (file)

Function: git-diff-index TREE-ISH &key PATHS PATCH UNIFIED RAW PATCH-WITH-RAW MINIMAL PATIENCE HISTOGRAM DIFF-ALGORITHM STAT NUMSTAT SHORTSTAT DIRSTAT SUMMARY PATCH-WITH-STAT NULL NAME-ONLY NAME-STATUS SUBMODULE COLOR WORD-DIFF WORD-DIFF-REGEX COLOR-WORDS NO-RENAMES CHECK WS-ERROR-HIGHLIGHT FULL-INDEX BINARY ABBREV BREAK-REWRITES FIND-RENAMES FIND-COPIES FIND-COPIES-HARDER IRREVERSIBLE-DELETE LIMIT-FIND DIFF-FILTER DIFFERING-OCCURRENCES DIFFERING-DIFFS PICKAXE-ALL PICKAXE-REGEX ORDER SWAP RELATIVE TEXT IGNORE-SPACE-AT-EOL IGNORE-SPACE-CHANGE IGNORE-ALL-SPACE IGNORE-BLANK-LINES INTER-HUNK-CONTEXT FUNCTION-CONTEXT EXT-DIFF TEXTCONV IGNORE-SUBMODULES SRC-PREFIX DST-PREFIX NO-PREFIX REPORT-UNCHECKED CACHED

git diff-index

See https://git-scm.com/docs/git-diff-index

Package

legit

Source

low-level.lisp (file)

Function: git-fast-import &key FORCE QUIET STATS CAT-BLOB-FD DATE-FORMAT DONE EXPORT-MARKS IMPORT-MARKS IMPORT-MARKS-IF-EXISTS RELATIVE-MARKS ACTIVE-BRANCHES BIG-FILE-THRESHOLD DEPTH EXPORT-PACK MAX-PACK-SIZE

git fast-import

See https://git-scm.com/docs/git-fast-import

Package

legit

Source

low-level.lisp (file)

Function: git-fetch &key REPOSITORY REFSPECS GROUP REPOSITORIES GROUPS ALL APPEND DEPTH UNSHALLOW UPDATE-SHALLOW DRY-RUN FORCE KEEP MULTIPLE PRUNE NO-TAGS REFMAP TAGS RECURSE-SUBMODULES SUBMODULE-PREFIX RECURSE-SUBMODULES-DEFAULT UPDATE-HEAD-OK UPLOAD-PACK QUIET VERBOSE PROGRESS

git fetch

See https://git-scm.com/docs/git-fetch

Package

legit

Source

low-level.lisp (file)

Function: git-filter-branch &key OPTIONS ENV-FILTER TREE-FILTER INDEX-FILTER PARENT-FILTER MSG-FILTER COMMIT-FILTER TAG-NAME-FILTER SUBDIRECTORY-FILTER PRUNE-EMPTY ORIGINAL DIRECTORY FORCE

git filter-branch

See https://git-scm.com/docs/git-filter-branch

Package

legit

Source

low-level.lisp (file)

Function: git-for-each-ref &key PATTERNS COUNT SHELL PERL PYTHON TCL SORT FORMAT

git for-each-ref

See https://git-scm.com/docs/git-for-each-ref

Package

legit

Source

low-level.lisp (file)

Function: git-format-patch &key OPTIONS SINCE REVISION-RANGE NO-STAT NO-PATCH UNIFIED MINIMAL PATIENCE HISTOGRAM DIFF-ALGORIGTHM STAT NUMSTAT SHORTSTAT DIRSTAT SUMMARY NO-RENAMES FULL-INDEX BINARY ABBREV BREAK-REWRITES FIND-RENAMES FIND-COPIES FIND-COPIES-HARDER IRREVERSIBLE-DELETE LIMIT-FIND ORDER TEXT IGNORE-SPACE-AT-EOL IGNORE-SPACE-CHANGE IGNORE-ALL-SPACE IGNORE-BLANK-LINES INTER-HUNK-CONTEXT FUNCTION-CONTEXT EXT-DIFF TEXTCONV IGNORE-SUBMODULES SRC-PREFIX DST-PREFIX NO-PREFIX OUTPUT-DIRECTORY NUMBERED START-NUMBER NUMBERED-FILES KEEP-SUBJECT SIGNOFF STDOUT ATTACH INLINE THREAD IN-REPLY-TO IGNORE-IF-IN-UPSTREAM SUBJECT-PREFIX REROLL-COUNT TO CC FROM ADD-HEADER COVER-LETTER NOTES SIGNATURE SIGNATURE-FILE SUFFIX QUIET NO-BINARY ROOT

git format-patch

See https://git-scm.com/docs/git-format-patch

Package

legit

Source

low-level.lisp (file)

Function: git-fsck &key OBJECTS UNREACAKBLE DANGLING ROOT TAGS CACHE NO-REFLOGS FULL STRICT VERBOSE LOST-FOUND PROGRESS

git fsck

See https://git-scm.com/docs/git-fsck

Package

legit

Source

low-level.lisp (file)

Function: git-gc &key AGGRESSIVE AUTO PRUNE QUIET FORCE

git gc

See https://git-scm.com/docs/git-gc

Package

legit

Source

low-level.lisp (file)

Function: git-grep &key TREE PATHS CACHED NO-INDEX UNTRACKED EXCLUDE-STANDARD TEXT TEXTCONV IGNORE-CASE NO-BINARY MAX-DEPTH WORD-REGEXP INVERT-MATCH SUPPRESS-FILENAME FULL-NAME EXTENDED-REGEXP BASIC-REGEXP PERL-REGEXP FIXED-STRINGS LINE-NUMBER NAME-ONLY NULL COUNT COLOR BREAK HEADING SHOW-FUNCTION CONTEXT AFTER-CONTEXT BEFORE-CONTEXT FUNCTION-CONTEXT FILE PATTERN AND OR NOT ALL-MATCH QUIET

git grep

See https://git-scm.com/docs/git-grep

Package

legit

Source

low-level.lisp (file)

Function: git-hash-object FILES &key TYPE WRITE STDIN STDIN-PATHS PATH NO-FILTERS LITERALLY

git hash-object

See https://git-scm.com/docs/git-hash-object

Package

legit

Source

low-level.lisp (file)

Function: git-help COMMAND-OR-GUIDE &key ALL GUIDES INFO MAN WEB

git help

See https://git-scm.com/docs/git-help

Package

legit

Source

low-level.lisp (file)

Function: git-init &key DIRECTORY QUIET BARE TEMPLATE SEPARATE-GIT-DIR SHARED

git init

See https://git-scm.com/docs/git-init

Package

legit

Source

low-level.lisp (file)

Function: git-instaweb &key LOCAL HTTPD MODULE-PATH PORT BROWSER START STOP RESTART

git instaweb

See https://git-scm.com/docs/git-instaweb

Package

legit

Source

low-level.lisp (file)

Function: git-location-p LOCATION

Returns T if the given location/path is a, or within a git repository.

Package

legit

Source

repository.lisp (file)

Function: git-log &key REVISION-RANGE PATHS FOLLOW DECORATE SOURCE USE-MAILMAP FULL-DIFF LOG-SIZE RANGE MAX-COUNT SKIP SINCE UNTIL AUTHOR GREP-REFLOG ALL-MATCH INVERT-GREP REGEXP-IGNORE-CASE BASIC-REGEXP EXTENDED-REGEXP FIXED-STRINGS PERL-REGEXP REMOVE-EMPTY MERGES MIN-PARENTS MAX-PARENTS FIRST-PARENT NOT ALL BRANCHES TAGS REMOTES GLOB EXCLUDE REFLOG IGNORE-MISSING BISECT STDIN CHERRY-MARK CHERRY-PICK LEFT-ONLY RIGHT-ONLY CHERRY WALK-REFLOGS MERGE BOUNDARY SIMPLIFY-BY-DECORATION FULL-HISTORY DENSE SPARSE SIMPLIFY-MERGES ANCESTRY-PATH DATE-ORDER AUTHOR-DATE-ORDER TOPO-ORDER REVERSE NO-WALK DO-WALK RELATIVE-DATE DATE PARENTS CHILDREN LEFT-RIGHT GRAPH SHOW-LINEAR-BREAK SIMULTANEOUS-DIFF COMPRESSED-SIMULTANEOUS-DIFF FULL-MERGE-DIFF SHOW-RECURSIVE-DIFF SHOW-TREE-DIFF PRETTY FORMAT

git log

See https://git-scm.com/docs/git-log

Package

legit

Source

low-level.lisp (file)

Function: git-ls-files &key FILES CACHED DELETED MODIFIED OTHERS IGNORED STAGE DIRECTORY NO-EMPTY-DIRECTORY UNMERGED KILLED ZERO-TERMINATE EXCLUDE EXCLUDE-FROM EXCLUDE-PER-DIRECTORY EXCLUDE-STANDARD ERROR-UNMATCH WITH-TREE FULL-NAME ABBREV DEBUG

git ls-files

See https://git-scm.com/docs/git-ls-files

Package

legit

Source

low-level.lisp (file)

Function: git-merge &key HEAD COMMITS COMMIT EDIT FF FF-ONLY LOG STAT SQUASH STRATEGY STRATEGY-OPTION VERIFY-SIGNATURES SUMMARY QUIET VERBOSE PROGRESS GPG-SIGN MESSAGE RERERE-AUTOIPDATE ABORT

git merge

See https://git-scm.com/docs/git-merge

Package

legit

Source

low-level.lisp (file)

Function: git-merge-base &key REF COMMITS OCTOPUS INDEPENDENT IS-ANCESTOR FORK-POINT ALL

git merge-base

See https://git-scm.com/docs/git-merge-base

Package

legit

Source

low-level.lisp (file)

Function: git-mergetool &key FILES TOOL TOOL-HELP PROMPT

git mergetool

See https://git-scm.com/docs/git-mergetool

Package

legit

Source

low-level.lisp (file)

Function: git-mv SOURCES DESTINATION &key FODCE SKIP-ERRORS DRY-RUN VERBOSE

git mv

See https://git-scm.com/docs/git-mv

Package

legit

Source

low-level.lisp (file)

Function: git-pull &key REPOSITORY REFSPECS QUIET VERBOSE RECURSE-SUBMODULES COMMIT EDIT FF FF-ONLY LOG STAT SQUASH STRATEGY STRATEGY-OPTION VERIFY-SIGNATURES SUMMARY REBASE ALL APPEND DEPTH UNSHALLOW UPDATE-SHALLOW FORCE KEEP NO-TAGS UPDATE-HEAD-OK UPLOAD-PACK PROGRESS

git pull

See https://git-scm.com/docs/git-pull

Package

legit

Source

low-level.lisp (file)

Function: git-push &key REPOSITORY REFSPECS ALL PRUNE MIRROR DRY-RUN PORCELAIN DELETE TAGS FOLLOW-TAGS SIGNED ATOMIC RECEIVE-PACK FORCE-WITH-LEASE FORCE REPO SET-UPSTREAM THIN QUIET VERBOSE PROGRESS RECURSE-SUBMODULES VERIFY

git push

See https://git-scm.com/docs/git-push

Package

legit

Source

low-level.lisp (file)

Function: git-read-tree &key TREE-ISH1 TREE-ISH2 TREE-ISH3 MERGE RESET UPDATE TEMPORARY-INDEX DRY-RUN VERBOSE TRIVIAL AGGRESSIVE PREFIX EXCLUDE-PER-DIRECTORY INDEX-OUTPUT NO-SPARSE-CHECKOUT EMPTY

git read-tree

See https://git-scm.com/docs/git-read-tree

Package

legit

Source

low-level.lisp (file)

Function: git-rebase &key UPSTREAM BRANCH ONTO CONTINUE ABORT KEEP-EMPTY SKIP EDITO-TODO MERGE STRATEGY STRATEGY-OPTION GPG-SIGN QUIET VERBOSE STAT VERIFY CONTEXT FORCE-REBASE FORK-POINT IGNORE-WHITESPACE WHITESPACE COMMITTER-DATE-IS-AUTHOR-DATE IGNORE-DATE INTERACTIVE PRESERVE-MERGES EXEC ROOT AUTOSQUASH AUTOSTASH NO-FF

git rebase

See https://git-scm.com/docs/git-rebase

Package

legit

Source

low-level.lisp (file)

Function: git-reflog ACTION &key ALL EXPIRE EXPIRE-UNREACHABLE UPDATEREF REWRITE STALE-FIX DRY-RUN VERBOSE FOLLOW DECORATE SOURCE USE-MAILMAP FULL-DIFF LOG-SIZE RANGE MAX-COUNT SKIP SINCE UNTIL AUTHOR GREP-REFLOG ALL-MATCH INVERT-GREP REGEXP-IGNORE-CASE BASIC-REGEXP EXTENDED-REGEXP FIXED-STRINGS PERL-REGEXP REMOVE-EMPTY MERGES MIN-PARENTS MAX-PARENTS FIRST-PARENT NOT BRANCHES TAGS REMOTES GLOB EXCLUDE REFLOG IGNORE-MISSING BISECT STDIN CHERRY-MARK CHERRY-PICK LEFT-ONLY RIGHT-ONLY CHERRY WALK-REFLOGS MERGE BOUNDARY SIMPLIFY-BY-DECORATION FULL-HISTORY DENSE SPARSE SIMPLIFY-MERGES ANCESTRY-PATH DATE-ORDER AUTHOR-DATE-ORDER TOPO-ORDER REVERSE NO-WALK DO-WALK RELATIVE-DATE DATE PARENTS CHILDREN LEFT-RIGHT GRAPH SHOW-LINEAR-BREAK SIMULTANEOUS-DIFF COMPRESSED-SIMULTANEOUS-DIFF FULL-MERGE-DIFF SHOW-RECURSIVE-DIFF SHOW-TREE-DIFF

git reflog

See https://git-scm.com/docs/git-reflog

Package

legit

Source

low-level.lisp (file)

Function: git-remote ACTION &key NAME URL OLD NEW BRANCHES NEWURL OLDURL NAMES GROUPS REMOTES VERBOSE TAGS MIRROR AUTO ADD PUSH DELETE DRY-RUN PRUNE IMMEDIATE TRACK SYMLINK NO-QUERY

git remote

See https://git-scm.com/docs/git-remote

Package

legit

Source

low-level.lisp (file)

Function: git-request-pull START URL &key END PATCH

git request-pull

See https://git-scm.com/docs/git-request-pull

Package

legit

Source

low-level.lisp (file)

Function: git-reset &key TREE-ISH PATHS SOFT MIXED HARD MERGE KEEP QUIET PATCH

git reset

See https://git-scm.com/docs/git-reset

Package

legit

Source

low-level.lisp (file)

Function: git-rev-list &key MAX-COUNT SKIP SINCE UNTIL MAX-AGE AUTHOR GREP-REFLOG GREP ALL-MATCH INVERT-GREP REGEXP-IGNORE-CASE BASIC-REGEXP EXTENDED-REGEXP FIXED-STRINGS PERL-REGEXP REMOVE-EMPTY MERGES MIN-PARENTS MAX-PARENTS FIRST-PARENT ALL BRANCHES TAGS REMOTES GLOB EXCLUDE REFLOG IGNORE-MISSING STDIN QUIET CHERRY-MARK CHERRY-PICK LEFT-ONLY RIGHT-ONLY CHERRY WALK-REFLOGS MERGE BOUNDARY USE-BITMAP-INDEX SIMPLIFY-BY-DECORATION FULL-HISTORY DENSE SPARSE SIMPLIFY-MERGES ANCESTRY-PATH BISECT BISECT-VARS BISECT-ALL DATE-ORDER AUTHOR-DATE-ORDER TOPO-ORDER REVERSE OBJECTS OBJECTS-EDGE OBJECTS-EDGE-AGGRESSIVE INDEXED-OBJECTS UNPACKED NO-WALK DO-WALK RELATIVE-DATE DATE HEADER PARENTS CHILDREN TIMESTAMP LEFT-RIGHT GRAPH SHOW-LINEAR-BREAK COUNT FULL-MERGE-DIFF SHOW-RECURSIVE-DIFF SHOW-TREE-DIFF

git rev-list

See https://git-scm.com/docs/git-rev-list

Package

legit

Source

low-level.lisp (file)

Function: git-rev-parse REVS &key PARSEOPT SQ-QUOTE KEEP-DASHDASH STOP-AT-NON-OPTION STUCK-LONG REVS-ONLY NO-REVS FLAGS DEFAULT PREFIX VERIFY QUIET ABBREV-REF SHORT SYMBOLIC SYMBOLIC-FULL-NAME ALL BRANCHES TAGS REMOTES GLOB EXCLUDE DISAMBIGUATE LOCAL-ENV-VARS GIT-DIR GIT-COMMON-DIR IS-INSIDE-GIT-DIR IS-INSIDE-WORK-TREE IS-BARE-REPOSITORY RESOLVE-GIT-DIR GIT-PATH SHOW-CDUP SHOW-PREFIX SHOW-TOPLEVEL SHARED-INDEX-PATH SINCE UNTIL

git rev-parse

See https://git-scm.com/docs/git-rev-parse

Package

legit

Source

low-level.lisp (file)

Function: git-revert &key COMMITS EDIT MAINLINE NO-COMMIT GPG-SIGN SIGNOFF STRATEGY STRATEGY-OPTION CONTINUE QUIT ABORT

git revert

See https://git-scm.com/docs/git-revert

Package

legit

Source

low-level.lisp (file)

Function: git-rm FILES &key FORCE DRY-RUN RECURSIVE CACHED IGNORE-UNMATCH QUIET

git rm

See https://git-scm.com/docs/git-rm

Package

legit

Source

low-level.lisp (file)

Function: git-shortlog &key REVISION-RANGE PATHS NUMBERED SUMMARY EMAIL FORMAT WIDTH

git shortlog

See https://git-scm.com/docs/git-shortlog

Package

legit

Source

low-level.lisp (file)

Function: git-show OBJECTS &key PRETTY ABBREV-COMMIT ONELINE ENCODING NOTES SHOW-NOTES STANDARD-NOTES SHOW-SIGNATURE PATCH UNIFIED RAW PATCH-WITH-RAW MINIMAL PATIENCE HISTOGRAM DIFF-ALGORIGTHM STAT NUMSTAT SHORTSTAT DIRSTAT SUMMARY PATCH-WITH-STAT NULL NAME-ONLY NAME-STATUS SUBMODULE COLOR WORD-DIFF WORD-DIFF-REGEX COLOR-WORDS NO-RENAMES CHECK WS-ERROR-HIGHLIGHT FULL-INDEX BINARY ABBREV BREAK-REWRITES FIND-RENAMES FIND-COPIES FIND-COPIES-HARDER IRREVERSIBLE-DELETE LIMIT-FIND DIFF-FILTER DIFFERING-OCCURRENCES DIFFERING-DIFFS PICKAXE-ALL PICKAXE-REGEX ORDER SWAP RELATIVE TEXT IGNORE-SPACE-AT-EOL IGNORE-SPACE-CHANGE IGNORE-ALL-SPACE IGNORE-BLANK-LINES INTER-HUNK-CONTEXT FUNCTION-CONTEXT EXT-DIFF TEXTCONV IGNORE-SUBMODULES SRC-PREFIX DST-PREFIX NO-PREFIX

git show

See https://git-scm.com/docs/git-show

Package

legit

Source

low-level.lisp (file)

Function: git-show-ref &key PATTERNS HEAD TAGS HEADS DEREFERENCE HASH VERIFY ABBREV QUIET EXCLUDE-EXISTING

git show-ref

See https://git-scm.com/docs/git-show-ref

Package

legit

Source

low-level.lisp (file)

Function: git-stash ACTION &key MESSAGE PATCH KEEP-INDEX INCLUDE-UNTRACKED ALL QUIET

git stash

See https://git-scm.com/docs/git-stash

Package

legit

Source

low-level.lisp (file)

Function: git-status PATHS &key SHORT BRANCH PORCELAIN LONG VERBOSE UNTRACKED-FILES IGNORE-SUBMODULES IGNORED NULL COLUMN

git status

See https://git-scm.com/docs/git-status

Package

legit

Source

low-level.lisp (file)

Function: git-submodule ACTION &key COMMIT PATHS REPOSITORY REPOSITORY-PATH QUIET BRANCH FORCE NAME REFERENCE DEPTH CACHED RECURSIVE INIT REMOTE NO-FETCH REBASE MERGE FILES SUMMARY-LIMIT

git submodule

See https://git-scm.com/docs/git-submodule

Package

legit

Source

low-level.lisp (file)

Function: git-svn COMMAND &key TRUNK TAGS BRANCHES STDLAYOUT NO-METADATA USE-SVM-PROPS USE-SVNSYNC-PROPS REWRITE-ROOT REWRITE-UUID USERNAME PREFIX IGNORE-PATHS INCLUDE-PATHS NO-MINIMIZE-URL LOCALTIME PARENT LOG-WINDOW-SIZE PRESERVE-EMPTY-DIRS PLACEHOLDER-FILENAME LOCAL NO-REBASE COMMIT-URL MERGEINFO INTERACTIVE MESSAGE TAG DESTINATION COMMIT-UTL PARENTS REVISION VERBOSE LIMIT INCREMENTAL SHOW-COMMIT ONELINE GIT-FORMAT BEFORE AFTER SHARED TEMPLATE STDIN RMDIR EDIT FIND-COPIES-HARDER AUTHORS-FILE AUTHORS-PROF QUIET MERGE STRATEGY PRESERVE-MERGES DRY-RUN USE-LOG-AUTHOR ADD-AUTHOR-FROM ID SVN-REMOTE FOLLOW-PARENT

git svn

See https://git-scm.com/docs/git-svn

Package

legit

Source

low-level.lisp (file)

Function: git-symbolic-ref NAME &key REF DELETE QUIET SHORT MESSAGE

git symbolic-ref

See https://git-scm.com/docs/git-symbolic-ref

Package

legit

Source

low-level.lisp (file)

Function: git-tag &key TAGS COMMIT OBJECT PATTERNS ANNOTATE SIGN LOCAL-USER FORCE DELETE VERIFY LINES LIST SORT COLUMN CONTAINS POINTS-AT MESSAGE FILE CLEANUP

git tag

See https://git-scm.com/docs/git-tag

Package

legit

Source

low-level.lisp (file)

Function: git-update-index &key FILES ADD REMOVE REFRESH QUIET IGNORE-SUBMODULES UNMERGED IGNORE-MISSING CACHEINFO INDEX-INFO CHMOD ASSUME-UNCHANGED REALLY-REFRESH SKIP-WORKTREE AGAIN UNRESOLVE INFO-ONLY FORCE-REMOVE REPLACE STDIN VERBOSE INDEX-VERSION NULL SPLIT-INDEX UNTRACKED-CACKE FORCE-UNTRACKED-CACHE

git update-index

See https://git-scm.com/docs/git-update-index

Package

legit

Source

low-level.lisp (file)

Function: git-update-ref &key REF NEWVALUE OLDVALUE MESSAGE DELETE NO-DEREF STDIN NULL

git update-ref

See https://git-scm.com/docs/git-update-ref

Package

legit

Source

low-level.lisp (file)

Function: git-update-server-info &key FORCE

git update-server-info

See https://git-scm.com/docs/git-update-server-info

Package

legit

Source

low-level.lisp (file)

Function: git-verify-pack PACKS &key VERBOSE STAT-ONLY

git verify-pack

See https://git-scm.com/docs/git-verify-pack

Package

legit

Source

low-level.lisp (file)

Function: git-write-tree &key MISSING-OK PREFIX

git write-tree

See https://git-scm.com/docs/git-write-tree

Package

legit

Source

low-level.lisp (file)

Function: relative-dir RELATIVE &rest SUBDIRS

Get a directory pathname that is SUBDIRS beneath RELATIVE.

Package

legit

Source

toolkit.lisp (file)

Function: (setf remotes) NEW-REMOTES REPO &rest ARGS

Package

legit

Source

repository.lisp (file)

Reader

remotes (generic function)

Function: run-git &rest CMDARGS

Launches a new git process with the given CMDARGS.

See LEGIT:RUN
See *GIT-OUTPUT*
See *GIT-ERRORS*
See *GIT-INPUT*

Package

legit

Source

process.lisp (file)

5.1.4 Generic functions

Generic Function: add REPOSITORY FILES &key &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: add (REPOSITORY repository) FILES &key

Method: add (REPOSITORY pathname) FILES &rest REST0

Method: add (REPOSITORY string) FILES &rest REST0

Generic Function: bare-p REPOSITORY &key &allow-other-keys

Returns T if the REPOSITORY is bare.

See GIT-REV-PARSE
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: bare-p (REPOSITORY repository) &key

Method: bare-p (REPOSITORY pathname) &rest REST0

Method: bare-p (REPOSITORY string) &rest REST0

Generic Function: checkout REPOSITORY THING &key &allow-other-keys

Checks out a specific THING in the repository.

This clears the cache.

See GIT-CHECKOUT
See REPOSITORY
See CLEAR-CACHE

Package

legit

Source

repository.lisp (file)

Methods

Method: checkout (REPOSITORY repository) THING &key

Method: checkout (REPOSITORY pathname) THING &rest REST0

Method: checkout (REPOSITORY string) THING &rest REST0

Generic Function: clean REPOSITORY &key DIRECTORIES FORCE IGNORED &allow-other-keys

Cleans the repository out.

Default extra keyword arguments are DIRECTORIES, FORCE, IGNORED.

See GIT-CLEAN
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: clean (REPOSITORY repository) &key DIRECTORIES FORCE IGNORED

Method: clean (REPOSITORY pathname) &rest REST0

Method: clean (REPOSITORY string) &rest REST0

Generic Function: clear-cache REPOSITORY &key KEY &allow-other-keys

Clears the internal cache on the git repository.

Calling this causes subsequent queries against the repository to actually launch a subprocess. This should be called whenever the repository on the file system may have been modified in any way.

See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: clear-cache (REPOSITORY repository) &key KEY

Method: clear-cache (REPOSITORY pathname) &rest REST0

Method: clear-cache (REPOSITORY string) &rest REST0

Generic Function: clone FROM TO &key BRANCH BARE SINGLE-BRANCH &allow-other-keys

Clone a repository from FROM to TO.

Default extra keyword arguments are BRANCH and BARE.

See GIT-CLONE

Package

legit

Source

repository.lisp (file)

Methods

Method: clone (FROM repository) TO &rest ARGS &key

Method: clone (FROM pathname) TO &rest ARGS &key

Method: clone (FROM string) (TO repository) &rest ARGS &key

Method: clone (FROM string) (TO pathname) &rest ARGS &key

Method: clone (FROM string) (TO string) &key BRANCH BARE SINGLE-BRANCH

Generic Function: commit REPOSITORY MESSAGE &key AMEND &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: commit (REPOSITORY repository) MESSAGE &key AMEND

Method: commit (REPOSITORY pathname) MESSAGE &rest REST0

Method: commit (REPOSITORY string) MESSAGE &rest REST0

Generic Function: commit-age REPOSITORY COMMIT &key &allow-other-keys

Returns a universal-time timestamp of when the given commit was made.

See GIT-LOG
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: commit-age (REPOSITORY repository) COMMIT &key

Method: commit-age (REPOSITORY pathname) COMMIT &rest REST0

Method: commit-age (REPOSITORY string) COMMIT &rest REST0

Generic Function: commit-author REPOSITORY COMMIT &key &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: commit-author (REPOSITORY repository) COMMIT &key

Method: commit-author (REPOSITORY pathname) COMMIT &rest REST0

Method: commit-author (REPOSITORY string) COMMIT &rest REST0

Generic Function: commit-message REPOSITORY COMMIT &key &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: commit-message (REPOSITORY repository) COMMIT &key

Method: commit-message (REPOSITORY pathname) COMMIT &rest REST0

Method: commit-message (REPOSITORY string) COMMIT &rest REST0

Generic Function: commits REPOSITORY &key &allow-other-keys

Returns the full list of commit hashes on the repository.

See GIT-REV-LIST
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: commits (REPOSITORY repository) &key

Method: commits (REPOSITORY pathname) &rest REST0

Method: commits (REPOSITORY string) &rest REST0

Generic Function: current-age REPOSITORY &key &allow-other-keys

Returns the latest commit’s age on the current branch of the REPOSITORY as a universal-time timestamp.

See GIT-LOG
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: current-age (REPOSITORY repository) &key

Method: current-age (REPOSITORY pathname) &rest REST0

Method: current-age (REPOSITORY string) &rest REST0

Generic Function: current-branch REPOSITORY &key &allow-other-keys

Returns the currently checked out branch of the REPOSITORY.

See GIT-REV-PARSE
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: current-branch (REPOSITORY repository) &key

Method: current-branch (REPOSITORY pathname) &rest REST0

Method: current-branch (REPOSITORY string) &rest REST0

Generic Function: current-commit REPOSITORY &key SHORT &allow-other-keys

Returns the latest commit hash on the current branch of the REPOSITORY.

See GIT-REV-PARSE
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: current-commit (REPOSITORY repository) &key SHORT

Method: current-commit (REPOSITORY pathname) &rest REST0

Method: current-commit (REPOSITORY string) &rest REST0

Generic Function: current-message REPOSITORY &key &allow-other-keys

Returns the latest commit’s message on the current branch of the REPOSITORY.

See GIT-LOG
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: current-message (REPOSITORY repository) &key

Method: current-message (REPOSITORY pathname) &rest REST0

Method: current-message (REPOSITORY string) &rest REST0

Generic Function: fetch REPOSITORY &key REMOTE BRANCH &allow-other-keys

Fetch the latest commits from upstream.

This clears the cache.

See GIT-FETCH
See REPOSITORY
See CLEAR-CACHE

Package

legit

Source

repository.lisp (file)

Methods

Method: fetch (REPOSITORY repository) &key REMOTE BRANCH

Method: fetch (REPOSITORY pathname) &rest REST0

Method: fetch (REPOSITORY string) &rest REST0

Generic Function: init REPOSITORY &key IF-DOES-NOT-EXIST REMOTE BRANCH BARE &allow-other-keys

Initialises the given repository.

REPOSITORY can be a pathname or repository. Optionally supplied keyword arguments are by default

IF-DOES-NOT-EXIST ::= :error — Signal an error if it does not exist. | :ignore — Just return a repository instance.
| :create | :init — Initialise a new, empty repository.
| :clone — Clone a new repository from a remote. REMOTE — An optional remote path used to clone the repository, if IF-DOES-NOT-EXIST is :CLONE
BRANCH — The branch to use if IF-DOES-NOT-EXIST is :CLONE, :CREATE, or :INIT.
BARE — Whether the repository should be bare if IF-DOES-NOT-EXIST is :CLONE, :CREATE, or :INIT.

See REPOSITORY
See GIT-INIT
See GIT-CHECKOUT
See GIT-CLONE

Package

legit

Source

repository.lisp (file)

Methods

Method: init (REPOSITORY string) &rest ARGS

Method: init (REPOSITORY pathname) &key IF-DOES-NOT-EXIST REMOTE BRANCH BARE

Method: init (REPOSITORY repository) &key IF-DOES-NOT-EXIST REMOTE BRANCH BARE

Generic Function: map-submodules REPOSITORY FUNCTION &key &allow-other-keys

Maps FUNCTION over all submodules of REPOSITORY.

See SUBDMODULES
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: map-submodules (REPOSITORY repository) FUNCTION &rest ARGS &key

Method: map-submodules (REPOSITORY pathname) FUNCTION &rest REST0

Method: map-submodules (REPOSITORY string) FUNCTION &rest REST0

Generic Function: pull REPOSITORY &key REMOTE REFSPECS &allow-other-keys

Pull and merge the latest commits from upstream.

This clears the cache.

See GIT-PULL
See REPOSITORY
See CLEAR-CACHE

Package

legit

Source

repository.lisp (file)

Methods

Method: pull (REPOSITORY repository) &key REMOTE REFSPECS

Method: pull (REPOSITORY pathname) &rest REST0

Method: pull (REPOSITORY string) &rest REST0

Generic Function: push REPOSITORY &key REMOTE REFSPECS &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: push (REPOSITORY repository) &key REMOTE REFSPECS

Method: push (REPOSITORY pathname) &rest REST0

Method: push (REPOSITORY string) &rest REST0

Generic Function: remote-url REPOSITORY &key REMOTE &allow-other-keys

Returns the address of a remote (default "origin") on the REPOSITORY.

Accepts a default keyword argument REMOTE.

See GIT-CONFIG
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: remote-url (REPOSITORY repository) &key REMOTE

Method: remote-url (REPOSITORY pathname) &rest REST0

Method: remote-url (REPOSITORY string) &rest REST0

Generic Function: remotes REPOSITORY &key &allow-other-keys

Returns an alist of all remotes on the REPOSITORY. The CAR is the name, the CDR the address.

This function is SETF-able, meaning you can PUSH new remotes to it or remove
remotes by SETF&REMOVE. It will also gracefully change the address of a remote
if it is changed in the setted list.

Setting REMOTES clears the cache.

See GIT-REMOTE
See REPOSITORY
See CLEAR-CACHE

Package

legit

Source

repository.lisp (file)

Writer

(setf remotes) (function)

Methods

Method: remotes (REPOSITORY repository) &key

Method: remotes (REPOSITORY pathname) &rest REST0

Method: remotes (REPOSITORY string) &rest REST0

Generic Function: reset REPOSITORY &key TO HARD MIXED SOFT &allow-other-keys

Resets changes in the repository.

Default extra keyword arguments are TO, HARD, MIXED, SOFT.

This clears the cache.

See GIT-RESET
See REPOSITORY
See CLEAR-CACHE

Package

legit

Source

repository.lisp (file)

Methods

Method: reset (REPOSITORY repository) &key TO HARD MIXED SOFT

Method: reset (REPOSITORY pathname) &rest REST0

Method: reset (REPOSITORY string) &rest REST0

Generic Function: submodules REPOSITORY &key RECURSIVE ONLY-EXISTING &allow-other-keys

Returns a list of REPOSITORY instances that represent the submodules of REPOSITORY.

See GIT-SUBMODULE
See REPOSITORY

Package

legit

Source

repository.lisp (file)

Methods

Method: submodules (REPOSITORY repository) &key RECURSIVE ONLY-EXISTING

Method: submodules (REPOSITORY pathname) &rest REST0

Method: submodules (REPOSITORY string) &rest REST0

5.1.5 Conditions

Condition: git-error ()

Package

legit

Source

process.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: command

Initargs

:command

Slot: exit-code

Initargs

:exit-code

Slot: error-text

Initargs

:error-text

Direct Default Initargs

Initarg	Value
:error-text	nil
:exit-code	(error "exit-code required.")
:command	(error "command required.")

5.1.6 Classes

Class: repository ()

A class to represent a git repository with.

This is a LOCATION.

See LOCATION
See INIT

Package

legit

Source

repository.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• bare-p (method)
• remote-url (method)
• current-age (method)
• current-message (method)
• current-branch (method)
• current-commit (method)
• commit-author (method)
• commit-message (method)
• commit-age (method)
• set-remotes (method)
• remotes (method)
• map-submodules (method)
• submodules (method)
• commits (method)
• push (method)
• commit (method)
• add (method)
• clean (method)
• reset (method)
• checkout (method)
• pull (method)
• fetch (method)
• clone (method)
• clone (method)
• init (method)
• clear-cache (method)
• print-object (method)
• cache (method)
• cache (method)
• location (method)
• location (method)

Direct slots

Slot: location

Initargs

:location

Readers

location (generic function)

Writers

(setf location) (generic function)

Slot: cache

Initform

(make-hash-table :test (quote equal))

Readers

cache (generic function)

Writers

(setf cache) (generic function)

Direct Default Initargs

Initarg	Value
:location	nil

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *unix-epoch-difference*

Package

legit

Source

toolkit.lisp (file)

5.2.2 Macros

Macro: %opt OPTIONS &rest FORMS

Package

legit

Source

toolkit.lisp (file)

Macro: argetypecase SYMB &body OPTIONS

Package

legit

Source

toolkit.lisp (file)

Macro: define-argparser FUNCNAME (DEFAULT SYMBOL PREFIX NAME OPTIONS) &body BODY

Package

legit

Source

toolkit.lisp (file)

Macro: define-git-wrapper NAME &rest ARGDEFS

Package

legit

Source

toolkit.lisp (file)

Macro: define-repo-function NAME (REPO &rest ARGS) &body BODY

Package

legit

Source

repository.lisp (file)

5.2.3 Functions

Function: %resolve-stream STREAMISH

Package

legit

Source

process.lisp (file)

Function: coerce-to-cmdarg THING

Package

legit

Source

process.lisp (file)

Function: ensure-list A

Package

legit

Source

toolkit.lisp (file)

Function: flatten ARGS

Package

legit

Source

process.lisp (file)

Function: front-arg-p ARG

Package

legit

Source

toolkit.lisp (file)

Function: git-send-email THINGS &key ANNOTATE BCC CC COMPOSE FROM IN-REPLY-TO SUBJECT TO 8BIT-ENCODING COMPOSE-ENCODING TRANSFER-ENCODING XMAILER ENVELOPE-SENDER SMTP-ENCRYPTION SMTP-DOMAIN SMTP-PASS SMTP-SERVER SMTP-SERVER-PORT SMTP-SERVER-OPTION SMTP-SSL SMTP-SSL-CERT-PATH SMTP-USER SMTP-DEBUG TO-CMD CC-CMD CHAIN-REPLY-TO IDENTITY SIGNED-OFF-BY-CC CC-COVER TO-COVER SUPPRESS-CC SUPPRESS-FROM THREAD CONFIRM DRY-RUN FORMAT-PATCH QUIET VALIDATE FORCE

git send-email

See https://git-scm.com/docs/git-send-email

Package

legit

Source

low-level.lisp (file)

Function: handle-init ACTION LOCATION REMOTE BRANCH BARE

Package

legit

Source

repository.lisp (file)

Function: minimal-shell-namestring PATHNAME

Package

legit

Source

toolkit.lisp (file)

Function: p-symb SYMBOL

Package

legit

Source

toolkit.lisp (file)

Function: parse-kargdef ARGDEF0

Package

legit

Source

toolkit.lisp (file)

Function: parse-oargdef ARGDEF0

Package

legit

Source

toolkit.lisp (file)

Function: parse-rargdef ARGDEF0

Package

legit

Source

toolkit.lisp (file)

Function: purify-args ARGS

Package

legit

Source

toolkit.lisp (file)

Function: shellify ARG

Package

legit

Source

toolkit.lisp (file)

Function: universal-to-unix-time UNIVERSAL-TIME

Package

legit

Source

toolkit.lisp (file)

Function: unix-to-universal-time UNIX-TIME

Package

legit

Source

toolkit.lisp (file)

5.2.4 Generic functions

Generic Function: cache OBJECT

Generic Function: (setf cache) NEW-VALUE OBJECT

Package

legit

Methods

Method: cache (REPOSITORY repository)

automatically generated reader method

Source

repository.lisp (file)

Method: (setf cache) NEW-VALUE (REPOSITORY repository)

automatically generated writer method

Source

repository.lisp (file)

Generic Function: set-remotes REPOSITORY NEW-REMOTES &key &allow-other-keys

Package

legit

Source

repository.lisp (file)

Methods

Method: set-remotes (REPOSITORY repository) (NEW-REMOTES list) &key

Method: set-remotes (REPOSITORY pathname) NEW-REMOTES &rest REST0

Method: set-remotes (REPOSITORY string) NEW-REMOTES &rest REST0

Appendix A Indexes

A.1 Concepts

A.2 Functions