The cl-autorepo Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-autorepo Reference Manual

This is the cl-autorepo Reference Manual, version 1.0.0, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:24:50 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-autorepo is a simple lisp library to ease inclusion of
non-Quicklisp libraries from repositories.

For example, to load my File System DataBase library:

  (ql:quickload "cl-autorepo")
  (cl-autorepo:add-system "fsdb" "https://github.com/billstclair/fsdb" :git)
  (ql:quickload "fsdb")

You can add ADD-SYSTEM calls to your library system definition (.asd)
files, to auto-download systems that aren't yet in Quicklisp.

Downloaded systems are kept in ~/.local/share/common-lisp/source/,
which is one of the places ASDF looks for systems by default.

There is currently no support for updating libraries. You can easily
do that yourself with "git pull", "svn update", etc.

I've included support for git, svn, darcs, and hg. You can add another
respository type with a simple DOWNLOAD-REPO method. Send it to me,
and I'll add it.

One way to autoload cl-autorepo itself, before it becomes part of
Quicklisp, is the code below:

(load "~/quicklisp/setup")              ;may be in your init file

(unless (or (find-package :cl-autorepo)
            (ignore-errors (ql:quickload "cl-autorepo")))
  (let* ((dir "~/.local/share/common-lisp/source/")
         (autorepo-asd (merge-pathnames "cl-autorepo/cl-autorepo.asd" dir))
         (url "https://github.com/billstclair/cl-autorepo"))
    (asdf:run-shell-command "mkdir -p ~a;cd ~a;git clone ~a" dir dir url)
    (load autorepo-asd)
    (ql:quickload "cl-autorepo")))

For an example of using cl-autorepo in a real system, see:

  https://github.com/billstclair/truledger/blob/master/truledger.asd

Tested in ccl 1.7-r14927M and SBCL 1.0.49.0.debian

Bill St. Clair
bill@billstclair.com
11 August, 2011


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-autorepo

Author

Bill St. Clair <bill@billstclair.com>

License

Apache

Description

A simple mechanism to auto-load ASDF systems from repositories.

Version

1.0.0

Source

cl-autorepo.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 cl-autorepo/src

Parent

cl-autorepo (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-autorepo.asd

Location

cl-autorepo.asd

Systems

cl-autorepo (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-autorepo/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-autorepo


Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-autorepo/src/autorepo.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/autorepo.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 cl-autorepo

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: add-system NAME URL &optional REPOSITORY-TYPE

Download the system named NAME of REPOSITORY-TYPE from the URL, unless it’s already defined.

Package

cl-autorepo

Source

autorepo.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: download-repo REPOSITORY-TYPE URL DIRECTORY

Download a repository of REPOSITORY-TYPE from URL, as a
subdirectory of DIRECTORY. REPOSITORY-TYPE can be :GIT, :SVN, :DARCS, or :HG

Package

cl-autorepo

Source

autorepo.lisp (file)

Methods
Method: download-repo (REPOSITORY-TYPE (eql hg)) URL DIRECTORY
Method: download-repo (REPOSITORY-TYPE (eql darcs)) URL DIRECTORY
Method: download-repo (REPOSITORY-TYPE (eql svn)) URL DIRECTORY
Method: download-repo (REPOSITORY-TYPE (eql git)) URL DIRECTORY

Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *repo-dir*
Package

cl-autorepo

Source

autorepo.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: download-repo-helper PROGRAM-ARGS DIRECTORY URL
Package

cl-autorepo

Source

autorepo.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-autorepo.asd: The cl-autorepo<dot>asd file
cl-autorepo/src: The cl-autorepo/src module
cl-autorepo/src/autorepo.lisp: The cl-autorepo/src/autorepo<dot>lisp file
cl-autorepo/src/package.lisp: The cl-autorepo/src/package<dot>lisp file

F
File, Lisp, cl-autorepo.asd: The cl-autorepo<dot>asd file
File, Lisp, cl-autorepo/src/autorepo.lisp: The cl-autorepo/src/autorepo<dot>lisp file
File, Lisp, cl-autorepo/src/package.lisp: The cl-autorepo/src/package<dot>lisp file

L
Lisp File, cl-autorepo.asd: The cl-autorepo<dot>asd file
Lisp File, cl-autorepo/src/autorepo.lisp: The cl-autorepo/src/autorepo<dot>lisp file
Lisp File, cl-autorepo/src/package.lisp: The cl-autorepo/src/package<dot>lisp file

M
Module, cl-autorepo/src: The cl-autorepo/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   F   G   M  
Index Entry  Section

A
add-system: Exported functions

D
download-repo: Exported generic functions
download-repo: Exported generic functions
download-repo: Exported generic functions
download-repo: Exported generic functions
download-repo: Exported generic functions
download-repo-helper: Internal functions

F
Function, add-system: Exported functions
Function, download-repo-helper: Internal functions

G
Generic Function, download-repo: Exported generic functions

M
Method, download-repo: Exported generic functions
Method, download-repo: Exported generic functions
Method, download-repo: Exported generic functions
Method, download-repo: Exported generic functions

Jump to:   A   D   F   G   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*repo-dir*: Internal special variables

S
Special Variable, *repo-dir*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-autorepo: The cl-autorepo system
cl-autorepo: The cl-autorepo package

P
Package, cl-autorepo: The cl-autorepo package

S
System, cl-autorepo: The cl-autorepo system

Jump to:   C   P   S