This is the deoxybyte-systems Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:01:57 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
deoxybyte-systems
Keith James
New BSD
1.0.0
cl-fad
(system)., at least version "0.6.2"
deoxybyte-systems
(module).
Modules are listed depth-first from the system components tree.
deoxybyte-systems/deoxybyte-systems
deoxybyte-systems
(system).
package.lisp
(file).
asdf-extensions.lisp
(file).
deoxybyte-systems.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
deoxybyte-systems/deoxybyte-systems.asd
deoxybyte-systems/deoxybyte-systems/package.lisp
deoxybyte-systems/deoxybyte-systems/asdf-extensions.lisp
deoxybyte-systems/deoxybyte-systems/deoxybyte-systems.lisp
deoxybyte-systems/deoxybyte-systems.asd
deoxybyte-systems
(system).
deoxybyte-systems/deoxybyte-systems/package.lisp
deoxybyte-systems
(module).
deoxybyte-systems/deoxybyte-systems/asdf-extensions.lisp
package.lisp
(file).
deoxybyte-systems
(module).
maybe-build-cldoc-docs
(function).
maybe-run-lift-tests
(function).
doc-op
(class).
deoxybyte-systems/deoxybyte-systems/deoxybyte-systems.lisp
asdf-extensions.lisp
(file).
deoxybyte-systems
(module).
document-system
(function).
load-system
(function).
Packages are listed by definition order.
uk.co.deoxybyte-systems
The deoxybyte-systems system provides tools for
managing Common Lisp systems in batch mode and from the REPL. It
provides convenient wrapper functions for ASDF operations and collects
my ASDF extensions in one place, instead of copy-pasting them into the
system definition files that need them. It does not add symbols to
the ASDF package.
This system is required by most of my other Common Lisp systems
because it supplies the unit test and documentation support (using
LIFT {http://common-lisp.net/project/lift/} and CLDOC
{http://common-lisp.net/project/cldoc/} respectively.
This system requires ASDF 3 and will not function correctly with older
ASDF versions. One new ASDF operation is provided by this system:
- cldoc-op: Runs CLDOC to extract docstrings in HTML format.
Two utility functions are provided to allow LIFT tests to be run and
CLDOC documentation to be generated if LIFT and/or CLDOC are present,
degrading gracefully if they are not.
To use these in an ASDF file, first load these extensions. One way to
do this is to use a method specific to your Lisp platform (e.g. Steel
bank Common Lisp provides the .sbclrc file):
;;; (in-package :cl-user)
;;; (require ’asdf)
;;; (asdf:operate ’asdf:load-op :deoxybyte-systems)
Alternatively, the system can be loaded on demand by the ASDF file
that will use :deoxybyte-systems functions:
;;; (eval-when (:compile-toplevel :load-toplevel :execute)
;;; (when (asdf:find-system :deoxybyte-systems nil)
;;; (asdf:load-system :deoxybyte-systems)))
;;; or loaded unconditionally:
;;; (in-package :cl-user)
;;; (asdf:load-system :deoxybyte-systems)
Then use standard ASDF syntax to add new components:
;;; (defsystem example-system
;;; :name "Example system"
;;; :in-order-to ((test-op (load-op :example-system
;;; :example-system-test))
;;; (doc-op (load-op :cldoc)))
;;; :components ((:module :src
;;; :serial t
;;; :pathname "src/"
;;; :components ((:file "package.lisp")
;;; (:file "example.lisp")))
;;; :perform (test-op :after (op c)
;;; (maybe-run-lift-tests :example-system
;;; "example-lift-test.config"))
;;; :perform (doc-op :after (op c)
;;; (maybe-build-cldoc-docs :example-system "doc/html")))
To load a system:
;;; (dxs:load-system :example-system)
or the equivalent:
;;; (asdf:load-system :example-system)
To run tests:
;;; (dxs:test-system :example-system)
or the equivalent:
;;; (asdf:test-system :example-system)
To generate system documentation:
;;; (dxs:document-system :example-system)
deoxybyte-systems
dxs
common-lisp
.
document-system
(function).
load-system
(function).
maybe-build-cldoc-docs
(function).
maybe-run-lift-tests
(function).
doc-op
(class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Extracts documentation from SYSTEM using ASDF and CLDOC.
Alias for ASDF:LOAD-SYSTEM.
When CLDOC is available, build HTML documentation for SYSTEM-NAME with TITLE .
When LIFT is available, run tests on SYSTEM-NAME using configuration in LIFT-CONFIG-FILENAME .
An ASDF operation that extracts docstring documentation from Lisp code using CLDOC.
operation
.
Jump to: | D F L M |
---|
Jump to: | D F L M |
---|
Jump to: | A C D F M P S U |
---|
Jump to: | A C D F M P S U |
---|