The 40ants-asdf-system Reference Manual

This is the 40ants-asdf-system Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:12:08 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 40ants-asdf-system

Provides a class for being used instead of asdf:package-inferred-system.

Author

Alexander Artemenko

Source Control

(GIT https://github.com/40ants/40ants-asdf-system)

Bug Tracker

https://github.com/40ants/40ants-asdf-system/issues

License

BSD

Source

40ants-asdf-system.asd.

Child Component

src (module).


3 Modules

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


3.1 40ants-asdf-system/src

Source

40ants-asdf-system.asd.

Parent Component

40ants-asdf-system (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 40ants-asdf-system/40ants-asdf-system.asd

Source

40ants-asdf-system.asd.

Parent Component

40ants-asdf-system (system).

ASDF Systems

40ants-asdf-system.


4.1.2 40ants-asdf-system/src/package.lisp

Source

40ants-asdf-system.asd.

Parent Component

src (module).

Packages

40ants-asdf-system.


4.1.3 40ants-asdf-system/src/version.lisp

Dependency

package.lisp (file).

Source

40ants-asdf-system.asd.

Parent Component

src (module).

Internals

4.1.4 40ants-asdf-system/src/readme.lisp

Dependency

package.lisp (file).

Source

40ants-asdf-system.asd.

Parent Component

src (module).

Internals

retrieve-system-readme (function).


4.1.5 40ants-asdf-system/src/system.lisp

Dependency

version.lisp (file).

Source

40ants-asdf-system.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 40ants-asdf-system

Source

package.lisp.

Nickname

40ants-asdf-system/system

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Generic functions

Generic Reader: path-to-changelog (object)
Package

40ants-asdf-system.

Methods
Reader Method: path-to-changelog ((40ants-asdf-system 40ants-asdf-system))

System relative path to a changelog, if string is given, then it will be processed using uiop:parse-unix-namestring function.

Source

system.lisp.

Target Slot

path-to-changelog.

Generic Reader: path-to-readme (object)
Package

40ants-asdf-system.

Methods
Reader Method: path-to-readme ((40ants-asdf-system 40ants-asdf-system))

System relative path to a README.md, if string is given, then it will be processed using uiop:parse-unix-namestring function.

Source

system.lisp.

Target Slot

path-to-readme.


6.1.2 Standalone methods

Method: operate :before ((op build-op) (system 40ants-asdf-system) &rest rest)

This method is called when user does ASDF:MAKE.

Package

asdf/operate.

Source

system.lisp.

Method: operate :before ((op load-op) (system 40ants-asdf-system) &rest rest)

This method is called when user does ASDF:LOAD-SYSTEM.

Package

asdf/operate.

Source

system.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: extract-version-from-changelog (changelog-file)
Package

40ants-asdf-system.

Source

version.lisp.

Function: read-file-forms (filename)
Package

40ants-asdf-system.

Source

version.lisp.

Function: retrieve-system-readme (system)
Package

40ants-asdf-system.

Source

readme.lisp.

Function: retrieve-system-version (system)
Package

40ants-asdf-system.

Source

version.lisp.

Function: set-40ants-system-version (system)
Package

40ants-asdf-system.

Source

system.lisp.


6.2.2 Classes

Class: 40ants-asdf-system

This ASDF system class takes it’s version from src/changelog.lisp

Package

asdf/interface.

Source

system.lisp.

Direct superclasses

package-inferred-system.

Direct methods
Direct slots
Slot: path-to-changelog

System relative path to a changelog, if string is given, then it will be processed using uiop:parse-unix-namestring function.

Package

40ants-asdf-system.

Type

(or string pathname)

Initform

"docs/changelog.lisp"

Initargs

:path-to-changelog

Readers

path-to-changelog.

Writers

This slot is read-only.

Slot: path-to-readme

System relative path to a README.md, if string is given, then it will be processed using uiop:parse-unix-namestring function.

Package

40ants-asdf-system.

Type

(or string pathname)

Initform

"readme.md"

Initargs

:path-to-readme

Readers

path-to-readme.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.3 Variables