The ql-checkout Reference Manual

This is the ql-checkout Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:36:57 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 ql-checkout

ql-checkout is library intend to checkout quicklisp maintained library with vcs.

Author

SANO Masatoshi

Contact

License

mit

Source

ql-checkout.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 ql-checkout/ql-checkout.asd

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

ASDF Systems

ql-checkout.


3.1.2 ql-checkout/config.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/config.

Public Interface

*checkoutdir* (special variable).


3.1.3 ql-checkout/github.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/github.

Public Interface

3.1.4 ql-checkout/meta-project.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/meta-project.

Public Interface
Internals

*projects* (special variable).


3.1.5 ql-checkout/vcs.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs.

Public Interface
Internals

*vcs-init* (special variable).


3.1.6 ql-checkout/project-quicklisp.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/project-quicklisp.

Public Interface
Internals

3.1.7 ql-checkout/project-ultralisp.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/project-ultralisp.

Public Interface
Internals

3.1.8 ql-checkout/vcs-quicklisp.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs-quicklisp.

Public Interface
Internals

3.1.9 ql-checkout/vcs-git.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs-git.

Public Interface
Internals

3.1.10 ql-checkout/vcs-svn.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs-svn.

Public Interface
Internals

svn (class).


3.1.11 ql-checkout/vcs-mercurial.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs-mercurial.

Public Interface
Internals

mercurial (class).


3.1.12 ql-checkout/vcs-darcs.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/vcs-darcs.

Public Interface
Internals

darcs (class).


3.1.13 ql-checkout/main.lisp

Source

ql-checkout.asd.

Parent Component

ql-checkout (system).

Packages

ql-checkout/main.

Public Interface

checkout (function).


4 Packages

Packages are listed by definition order.


4.1 ql-checkout/config

Source

config.lisp.

Use List

common-lisp.

Used By List
Public Interface

*checkoutdir* (special variable).


4.2 ql-checkout/vcs-svn

Source

vcs-svn.lisp.

Use List
Internals

svn (class).


4.3 ql-checkout/vcs-darcs

Source

vcs-darcs.lisp.

Use List
Internals

darcs (class).


4.4 ql-checkout/main

Source

main.lisp.

Nickname

ql-checkout

Use List
Public Interface

checkout (function).


4.5 ql-checkout/project-quicklisp

Source

project-quicklisp.lisp.

Use List
Internals

4.6 ql-checkout/vcs

Source

vcs.lisp.

Use List
Used By List
Public Interface
Internals

*vcs-init* (special variable).


4.7 ql-checkout/project-ultralisp

Source

project-ultralisp.lisp.

Use List
Internals

4.8 ql-checkout/github

Source

github.lisp.

Use List
Used By List

ql-checkout/meta-project.

Public Interface

4.9 ql-checkout/vcs-mercurial

Source

vcs-mercurial.lisp.

Use List
Internals

mercurial (class).


4.10 ql-checkout/meta-project

Source

meta-project.lisp.

Use List
Used By List
Public Interface
Internals

*projects* (special variable).


4.11 ql-checkout/vcs-git

Source

vcs-git.lisp.

Use List
Internals

4.12 ql-checkout/vcs-quicklisp

Source

vcs-quicklisp.lisp.

Use List
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *checkoutdir*
Package

ql-checkout/config.

Source

config.lisp.


5.1.2 Ordinary functions

Function: checkout (names &optional quiet)
Package

ql-checkout/main.

Source

main.lisp.

Function: clone-github (owner/name &key branch checkoutdir)
Package

ql-checkout/github.

Source

github.lisp.

Function: pull-github (owner/name &key checkoutdir)
Package

ql-checkout/github.

Source

github.lisp.

Function: register-project (name)
Package

ql-checkout/meta-project.

Source

meta-project.lisp.

Function: register-vcs (symbol)
Package

ql-checkout/vcs.

Source

vcs.lisp.

Function: vcs-find (name)
Package

ql-checkout/vcs.

Source

vcs.lisp.


5.1.3 Generic functions

Generic Function: find-source (project name)
Package

ql-checkout/meta-project.

Methods
Method: find-source ((project ultralisp) name)
Source

project-ultralisp.lisp.

Method: find-source ((project quicklisp) name)
Source

project-quicklisp.lisp.

Method: find-source ((project project) name)
Source

meta-project.lisp.

Generic Function: update (project &key)
Package

ql-checkout/meta-project.

Methods
Method: update ((project ultralisp) &key)
Source

project-ultralisp.lisp.

Method: update ((project quicklisp) &key)
Source

project-quicklisp.lisp.

Method: update ((project string) &key)
Source

meta-project.lisp.

Method: update ((project list) &key)
Source

meta-project.lisp.

Method: update ((project (eql :all)) &key)
Source

meta-project.lisp.

Method: update ((project project) &key)
Source

meta-project.lisp.

Generic Function: vcs-checkout (vcs directory quiet)
Package

ql-checkout/vcs.

Methods
Method: vcs-checkout ((vcs darcs) directory quiet)
Source

vcs-darcs.lisp.

Method: vcs-checkout ((vcs mercurial) directory quiet)
Source

vcs-mercurial.lisp.

Method: vcs-checkout ((vcs svn) directory quiet)
Source

vcs-svn.lisp.

Method: vcs-checkout ((vcs git) directory quiet)
Source

vcs-git.lisp.

Method: vcs-checkout ((vcs quicklisp) directory quiet)
Source

vcs-quicklisp.lisp.

Method: vcs-checkout (vcs directory quiet)
Source

vcs.lisp.

Generic Function: vcs-dir (vcs base)
Package

ql-checkout/vcs.

Methods
Method: vcs-dir (vcs base)
Source

vcs.lisp.

Generic Function: vcs-init (symbol params name)
Package

ql-checkout/vcs.

Methods
Method: vcs-init ((vcs (eql ql-checkout/vcs-darcs::darcs)) params name)
Source

vcs-darcs.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-mercurial::mercurial)) params name)
Source

vcs-mercurial.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-svn::svn)) params name)
Source

vcs-svn.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::ediware-http)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::kmr-git)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::latest-github-tag)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::latest-github-release)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::tagged-git)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::branched-git)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-git::git)) params name)
Source

vcs-git.lisp.

Method: vcs-init ((vcs (eql ql-checkout/vcs-quicklisp::single-file)) params name)
Source

vcs-quicklisp.lisp.

Method: vcs-init (symbol params name)
Source

vcs.lisp.

Generic Reader: vcs-name (object)
Package

ql-checkout/vcs.

Methods
Reader Method: vcs-name ((vcs vcs))

automatically generated reader method

Source

vcs.lisp.

Target Slot

name.

Generic Writer: (setf vcs-name) (object)
Package

ql-checkout/vcs.

Methods
Writer Method: (setf vcs-name) ((vcs vcs))

automatically generated writer method

Source

vcs.lisp.

Target Slot

name.

Generic Function: vcs-owner (vcs)
Package

ql-checkout/vcs.

Methods
Method: vcs-owner ((vcs darcs))
Source

vcs-darcs.lisp.

Method: vcs-owner ((vcs svn))
Source

vcs-svn.lisp.

Method: vcs-owner ((vcs kmr-git))
Source

vcs-git.lisp.

Method: vcs-owner ((vcs quicklisp))
Source

vcs-quicklisp.lisp.

Method: vcs-owner (vcs)
Source

vcs.lisp.

Generic Reader: vcs-uri (object)
Package

ql-checkout/vcs.

Methods
Reader Method: vcs-uri ((vcs vcs))

automatically generated reader method

Source

vcs.lisp.

Target Slot

uri.

Generic Writer: (setf vcs-uri) (object)
Package

ql-checkout/vcs.

Methods
Writer Method: (setf vcs-uri) ((vcs vcs))

automatically generated writer method

Source

vcs.lisp.

Target Slot

uri.


5.1.4 Classes

Class: project
Package

ql-checkout/meta-project.

Source

meta-project.lisp.

Direct subclasses
Direct methods
Class: vcs
Package

ql-checkout/vcs.

Source

vcs.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

vcs-uri.

Writers

(setf vcs-uri).

Slot: name
Initargs

:name

Readers

vcs-name.

Writers

(setf vcs-name).


5.2 Internals


5.2.1 Special variables

Special Variable: *projects*
Package

ql-checkout/meta-project.

Source

meta-project.lisp.

Special Variable: *vcs-init*
Package

ql-checkout/vcs.

Source

vcs.lisp.


5.2.2 Ordinary functions

Function: ensure-projectdata ()
Package

ql-checkout/project-quicklisp.

Source

project-quicklisp.lisp.

Function: ensure-projectdata ()
Package

ql-checkout/project-ultralisp.

Source

project-ultralisp.lisp.


5.2.3 Generic functions

Generic Reader: git-branch (object)
Package

ql-checkout/vcs-git.

Methods
Reader Method: git-branch ((git git))

automatically generated reader method

Source

vcs-git.lisp.

Target Slot

branch.

Generic Writer: (setf git-branch) (object)
Package

ql-checkout/vcs-git.

Methods
Writer Method: (setf git-branch) ((git git))

automatically generated writer method

Source

vcs-git.lisp.

Target Slot

branch.


5.2.4 Classes

Class: branched-git
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Class: darcs
Package

ql-checkout/vcs-darcs.

Source

vcs-darcs.lisp.

Direct superclasses

vcs.

Direct methods
Class: ediware-http
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Class: git
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

vcs.

Direct subclasses
Direct methods
Direct slots
Slot: branch
Initargs

:branch

Readers

git-branch.

Writers

(setf git-branch).

Class: kmr-git
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Direct methods

vcs-owner.

Class: latest-github-release
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Class: latest-github-tag
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Class: mercurial
Package

ql-checkout/vcs-mercurial.

Source

vcs-mercurial.lisp.

Direct superclasses

vcs.

Direct methods

vcs-checkout.

Class: quicklisp
Package

ql-checkout/project-quicklisp.

Source

project-quicklisp.lisp.

Direct superclasses

project.

Direct methods
Class: quicklisp
Package

ql-checkout/vcs-quicklisp.

Source

vcs-quicklisp.lisp.

Direct superclasses

vcs.

Direct subclasses

single-file.

Direct methods
Class: single-file
Package

ql-checkout/vcs-quicklisp.

Source

vcs-quicklisp.lisp.

Direct superclasses

quicklisp.

Class: svn
Package

ql-checkout/vcs-svn.

Source

vcs-svn.lisp.

Direct superclasses

vcs.

Direct methods
Class: tagged-git
Package

ql-checkout/vcs-git.

Source

vcs-git.lisp.

Direct superclasses

git.

Class: ultralisp
Package

ql-checkout/project-ultralisp.

Source

project-ultralisp.lisp.

Direct superclasses

project.

Direct methods

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   E   F   G   M   P   R   U   V  
Index Entry  Section

(
(setf git-branch): Private generic functions
(setf git-branch): Private generic functions
(setf vcs-name): Public generic functions
(setf vcs-name): Public generic functions
(setf vcs-uri): Public generic functions
(setf vcs-uri): Public generic functions

C
checkout: Public ordinary functions
clone-github: Public ordinary functions

E
ensure-projectdata: Private ordinary functions
ensure-projectdata: Private ordinary functions

F
find-source: Public generic functions
find-source: Public generic functions
find-source: Public generic functions
find-source: Public generic functions
Function, checkout: Public ordinary functions
Function, clone-github: Public ordinary functions
Function, ensure-projectdata: Private ordinary functions
Function, ensure-projectdata: Private ordinary functions
Function, pull-github: Public ordinary functions
Function, register-project: Public ordinary functions
Function, register-vcs: Public ordinary functions
Function, vcs-find: Public ordinary functions

G
Generic Function, (setf git-branch): Private generic functions
Generic Function, (setf vcs-name): Public generic functions
Generic Function, (setf vcs-uri): Public generic functions
Generic Function, find-source: Public generic functions
Generic Function, git-branch: Private generic functions
Generic Function, update: Public generic functions
Generic Function, vcs-checkout: Public generic functions
Generic Function, vcs-dir: Public generic functions
Generic Function, vcs-init: Public generic functions
Generic Function, vcs-name: Public generic functions
Generic Function, vcs-owner: Public generic functions
Generic Function, vcs-uri: Public generic functions
git-branch: Private generic functions
git-branch: Private generic functions

M
Method, (setf git-branch): Private generic functions
Method, (setf vcs-name): Public generic functions
Method, (setf vcs-uri): Public generic functions
Method, find-source: Public generic functions
Method, find-source: Public generic functions
Method, find-source: Public generic functions
Method, git-branch: Private generic functions
Method, update: Public generic functions
Method, update: Public generic functions
Method, update: Public generic functions
Method, update: Public generic functions
Method, update: Public generic functions
Method, update: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-checkout: Public generic functions
Method, vcs-dir: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-init: Public generic functions
Method, vcs-name: Public generic functions
Method, vcs-owner: Public generic functions
Method, vcs-owner: Public generic functions
Method, vcs-owner: Public generic functions
Method, vcs-owner: Public generic functions
Method, vcs-owner: Public generic functions
Method, vcs-uri: Public generic functions

P
pull-github: Public ordinary functions

R
register-project: Public ordinary functions
register-vcs: Public ordinary functions

U
update: Public generic functions
update: Public generic functions
update: Public generic functions
update: Public generic functions
update: Public generic functions
update: Public generic functions
update: Public generic functions

V
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-checkout: Public generic functions
vcs-dir: Public generic functions
vcs-dir: Public generic functions
vcs-find: Public ordinary functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-init: Public generic functions
vcs-name: Public generic functions
vcs-name: Public generic functions
vcs-owner: Public generic functions
vcs-owner: Public generic functions
vcs-owner: Public generic functions
vcs-owner: Public generic functions
vcs-owner: Public generic functions
vcs-owner: Public generic functions
vcs-uri: Public generic functions
vcs-uri: Public generic functions


A.4 Data types

Jump to:   B   C   D   E   F   G   K   L   M   P   Q   S   T   U   V  
Index Entry  Section

B
branched-git: Private classes

C
Class, branched-git: Private classes
Class, darcs: Private classes
Class, ediware-http: Private classes
Class, git: Private classes
Class, kmr-git: Private classes
Class, latest-github-release: Private classes
Class, latest-github-tag: Private classes
Class, mercurial: Private classes
Class, project: Public classes
Class, quicklisp: Private classes
Class, quicklisp: Private classes
Class, single-file: Private classes
Class, svn: Private classes
Class, tagged-git: Private classes
Class, ultralisp: Private classes
Class, vcs: Public classes
config.lisp: The ql-checkout/config․lisp file

D
darcs: Private classes

E
ediware-http: Private classes

F
File, config.lisp: The ql-checkout/config․lisp file
File, github.lisp: The ql-checkout/github․lisp file
File, main.lisp: The ql-checkout/main․lisp file
File, meta-project.lisp: The ql-checkout/meta-project․lisp file
File, project-quicklisp.lisp: The ql-checkout/project-quicklisp․lisp file
File, project-ultralisp.lisp: The ql-checkout/project-ultralisp․lisp file
File, ql-checkout.asd: The ql-checkout/ql-checkout․asd file
File, vcs-darcs.lisp: The ql-checkout/vcs-darcs․lisp file
File, vcs-git.lisp: The ql-checkout/vcs-git․lisp file
File, vcs-mercurial.lisp: The ql-checkout/vcs-mercurial․lisp file
File, vcs-quicklisp.lisp: The ql-checkout/vcs-quicklisp․lisp file
File, vcs-svn.lisp: The ql-checkout/vcs-svn․lisp file
File, vcs.lisp: The ql-checkout/vcs․lisp file

G
git: Private classes
github.lisp: The ql-checkout/github․lisp file

K
kmr-git: Private classes

L
latest-github-release: Private classes
latest-github-tag: Private classes

M
main.lisp: The ql-checkout/main․lisp file
mercurial: Private classes
meta-project.lisp: The ql-checkout/meta-project․lisp file

P
Package, ql-checkout/config: The ql-checkout/config package
Package, ql-checkout/github: The ql-checkout/github package
Package, ql-checkout/main: The ql-checkout/main package
Package, ql-checkout/meta-project: The ql-checkout/meta-project package
Package, ql-checkout/project-quicklisp: The ql-checkout/project-quicklisp package
Package, ql-checkout/project-ultralisp: The ql-checkout/project-ultralisp package
Package, ql-checkout/vcs: The ql-checkout/vcs package
Package, ql-checkout/vcs-darcs: The ql-checkout/vcs-darcs package
Package, ql-checkout/vcs-git: The ql-checkout/vcs-git package
Package, ql-checkout/vcs-mercurial: The ql-checkout/vcs-mercurial package
Package, ql-checkout/vcs-quicklisp: The ql-checkout/vcs-quicklisp package
Package, ql-checkout/vcs-svn: The ql-checkout/vcs-svn package
project: Public classes
project-quicklisp.lisp: The ql-checkout/project-quicklisp․lisp file
project-ultralisp.lisp: The ql-checkout/project-ultralisp․lisp file

Q
ql-checkout: The ql-checkout system
ql-checkout.asd: The ql-checkout/ql-checkout․asd file
ql-checkout/config: The ql-checkout/config package
ql-checkout/github: The ql-checkout/github package
ql-checkout/main: The ql-checkout/main package
ql-checkout/meta-project: The ql-checkout/meta-project package
ql-checkout/project-quicklisp: The ql-checkout/project-quicklisp package
ql-checkout/project-ultralisp: The ql-checkout/project-ultralisp package
ql-checkout/vcs: The ql-checkout/vcs package
ql-checkout/vcs-darcs: The ql-checkout/vcs-darcs package
ql-checkout/vcs-git: The ql-checkout/vcs-git package
ql-checkout/vcs-mercurial: The ql-checkout/vcs-mercurial package
ql-checkout/vcs-quicklisp: The ql-checkout/vcs-quicklisp package
ql-checkout/vcs-svn: The ql-checkout/vcs-svn package
quicklisp: Private classes
quicklisp: Private classes

S
single-file: Private classes
svn: Private classes
System, ql-checkout: The ql-checkout system

T
tagged-git: Private classes

U
ultralisp: Private classes

V
vcs: Public classes
vcs-darcs.lisp: The ql-checkout/vcs-darcs․lisp file
vcs-git.lisp: The ql-checkout/vcs-git․lisp file
vcs-mercurial.lisp: The ql-checkout/vcs-mercurial․lisp file
vcs-quicklisp.lisp: The ql-checkout/vcs-quicklisp․lisp file
vcs-svn.lisp: The ql-checkout/vcs-svn․lisp file
vcs.lisp: The ql-checkout/vcs․lisp file