Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jul 26, 2023
1 parent 5c886d8 commit 9175c52
Showing 1 changed file with 33 additions and 33 deletions.
66 changes: 33 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ All code is public domain except parts that were taken from [quicklisp-homebrew-

<a id="x-28-23A-28-289-29-20BASE-CHAR-20-2E-20-22CL-BREWER-22-29-20PACKAGE-29"></a>

#### [package](0047) `cl-brewer`
#### [package](6e0d) `cl-brewer`

<a id="x-28CL-BREWER-DOCS-2FINDEX-3A-3A-7C-40CL-BREWER-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -201,51 +201,51 @@ All code is public domain except parts that were taken from [quicklisp-homebrew-

<a id="x-28CL-BREWER-3AFORMULA-20CLASS-29"></a>

###### [class](4135) `cl-brewer:formula` ()
###### [class](ad76) `cl-brewer:formula` ()

Base class for Homebrew formula definition.

**Readers**

<a id="x-28CL-BREWER-2FFORMULA-3AINCLUDED-SYSTEMS-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-BREWER-3AFORMULA-29-29"></a>

###### [reader](9d80) `cl-brewer/formula:included-systems` (formula) (:included-systems)
###### [reader](7309) `cl-brewer/formula:included-systems` (formula) (:included-systems)

<a id="x-28CL-BREWER-2FFORMULA-3AMISSING-SYSTEMS-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-BREWER-3AFORMULA-29-29"></a>

###### [reader](7891) `cl-brewer/formula:missing-systems` (formula) (:missing-systems)
###### [reader](9ae5) `cl-brewer/formula:missing-systems` (formula) (:missing-systems)

<a id="x-28CL-BREWER-2FFORMULA-3AROOT-SYSTEM-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20CL-BREWER-3AFORMULA-29-29"></a>

###### [reader](eb6d) `cl-brewer/formula:root-system` (formula) (:root-system)
###### [reader](4961) `cl-brewer/formula:root-system` (formula) (:root-system)

**Accessors**

<a id="x-28CL-BREWER-2FFORMULA-3AINCLUDED-SYSTEMS-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20CL-BREWER-3AFORMULA-29-29"></a>

###### [accessor](9d80) `cl-brewer/formula:included-systems` (formula) (:included-systems)
###### [accessor](7309) `cl-brewer/formula:included-systems` (formula) (:included-systems)

<a id="x-28CL-BREWER-2FFORMULA-3AMISSING-SYSTEMS-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20CL-BREWER-3AFORMULA-29-29"></a>

###### [accessor](7891) `cl-brewer/formula:missing-systems` (formula) (:missing-systems)
###### [accessor](9ae5) `cl-brewer/formula:missing-systems` (formula) (:missing-systems)

<a id="x-28CL-BREWER-2FFORMULA-3AROOT-SYSTEM-20-2840ANTS-DOC-2FLOCATIVES-3AACCESSOR-20CL-BREWER-3AFORMULA-29-29"></a>

###### [accessor](eb6d) `cl-brewer/formula:root-system` (formula) (:root-system)
###### [accessor](4961) `cl-brewer/formula:root-system` (formula) (:root-system)

<a id="x-28CL-BREWER-DOCS-2FINDEX-3A-3A-7C-40CL-BREWER-3FGenerics-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Generics

<a id="x-28CL-BREWER-3ACREATE-FORMULA-20GENERIC-FUNCTION-29"></a>

##### [generic-function](97ae) `cl-brewer:create-formula` system
##### [generic-function](1399) `cl-brewer:create-formula` system

Create <formula> object based on asdf:system with a list of all dependencies

<a id="x-28CL-BREWER-3AGET-IMPLICIT-DEPENDENCIES-20GENERIC-FUNCTION-29"></a>

##### [generic-function](e9e3) `cl-brewer:get-implicit-dependencies` system-name
##### [generic-function](d2c8) `cl-brewer:get-implicit-dependencies` system-name

Some systems, like cl-unicode have implicit dependencies in their asdf methods:
[https://github.com/edicl/cl-unicode/blob/8073fc5634c9d4802888ac03abf11dfe383e16fa/cl-unicode.asd#L67-L70][44a6]
Expand All @@ -260,7 +260,7 @@ Each returned system should be possible to find with ql-dist:find-system.

<a id="x-28CL-BREWER-3ASAVE-FORMULA-20FUNCTION-29"></a>

##### [function](82e4) `cl-brewer:save-formula` formula name &key entry-point preload
##### [function](3f2a) `cl-brewer:save-formula` formula name &key entry-point preload

Saves Homebrew formula definition into the file with given `NAME`.

Expand All @@ -277,7 +277,7 @@ might ignore this argument.

<a id="x-28-23A-28-2826-29-20BASE-CHAR-20-2E-20-22CL-BREWER-2FBUILDAPP-2FFORMULA-22-29-20PACKAGE-29"></a>

#### [package](e461) `cl-brewer/buildapp/formula`
#### [package](1185) `cl-brewer/buildapp/formula`

<a id="x-28CL-BREWER-DOCS-2FINDEX-3A-3A-7C-40CL-BREWER-2FBUILDAPP-2FFORMULA-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -289,7 +289,7 @@ might ignore this argument.

<a id="x-28CL-BREWER-2FBUILDAPP-2FFORMULA-3ABUILDAPP-FORMULA-20CLASS-29"></a>

###### [class](b8f4) `cl-brewer/buildapp/formula:buildapp-formula` (formula)
###### [class](95ac) `cl-brewer/buildapp/formula:buildapp-formula` (formula)

This formula class uses [Buildapp][ebe7] to build a binary.

Expand All @@ -299,7 +299,7 @@ This formula class uses [Buildapp][ebe7] to build a binary.

<a id="x-28-23A-28-2824-29-20BASE-CHAR-20-2E-20-22CL-BREWER-2FDEPLOY-2FFORMULA-22-29-20PACKAGE-29"></a>

#### [package](9bd4) `cl-brewer/deploy/formula`
#### [package](8244) `cl-brewer/deploy/formula`

<a id="x-28CL-BREWER-DOCS-2FINDEX-3A-3A-7C-40CL-BREWER-2FDEPLOY-2FFORMULA-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -311,7 +311,7 @@ This formula class uses [Buildapp][ebe7] to build a binary.

<a id="x-28CL-BREWER-2FDEPLOY-2FFORMULA-3ADEPLOY-FORMULA-20CLASS-29"></a>

###### [class](3ddb) `cl-brewer/deploy/formula:deploy-formula` (formula)
###### [class](1be7) `cl-brewer/deploy/formula:deploy-formula` (formula)

This formula class uses [Deploy][eaea] to build a binary.

Expand All @@ -324,15 +324,15 @@ this type of formula also builds and distributes all necessary dynamic libraries

<a id="x-28-23A-28-2817-29-20BASE-CHAR-20-2E-20-22CL-BREWER-2FFORMULA-22-29-20PACKAGE-29"></a>

#### [package](577d) `cl-brewer/formula`
#### [package](b6c9) `cl-brewer/formula`

<a id="x-28CL-BREWER-DOCS-2FINDEX-3A-3A-7C-40CL-BREWER-2FFORMULA-3FGenerics-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Generics

<a id="x-28CL-BREWER-2FFORMULA-3AGET-ADDITIONAL-DEPENDENCIES-20GENERIC-FUNCTION-29"></a>

##### [generic-function](a4e4) `cl-brewer/formula:get-additional-dependencies` formula
##### [generic-function](9396) `cl-brewer/formula:get-additional-dependencies` formula

Some formulas might add dependencies needed to build a binary. For example, Deploy formula adds cl-brewer because it uses it's cl-brewer/deploy/hooks subsystem.

Expand All @@ -354,7 +354,7 @@ Some formulas might add dependencies needed to build a binary. For example, Depl

<a id="x-28CL-BREWER-2FFORMULA-3ADEFINE-QUESSER-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

##### [macro](6803) `cl-brewer/formula:define-quesser` name (asdf-system) &body body
##### [macro](b8e1) `cl-brewer/formula:define-quesser` name (asdf-system) &body body

Use this macro to define a function to guess a formula class.

Expand All @@ -371,21 +371,21 @@ then it should return a `NIL` value.
[4e9e]: https://40ants.com/cl-brewer/#x-28CL-BREWER-3AFORMULA-20CLASS-29
[df7d]: https://github.com/40ants/cl-brewer
[a54e]: https://github.com/40ants/cl-brewer/actions
[e461]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/buildapp/formula.lisp#L1
[b8f4]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/buildapp/formula.lisp#L13
[0047]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/core.lisp#L1
[9bd4]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/deploy/formula.lisp#L1
[3ddb]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/deploy/formula.lisp#L17
[82e4]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula-impl.lisp#L139
[577d]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L1
[6803]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L168
[4135]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L28
[eb6d]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L29
[7891]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L32
[9d80]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L35
[97ae]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L41
[e9e3]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L45
[a4e4]: https://github.com/40ants/cl-brewer/blob/b0e70e93c7f8b1a19d1d0a76319d24d8716f2d3a/src/formula.lisp#L68
[1185]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/buildapp/formula.lisp#L1
[95ac]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/buildapp/formula.lisp#L13
[6e0d]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/core.lisp#L1
[8244]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/deploy/formula.lisp#L1
[1be7]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/deploy/formula.lisp#L17
[3f2a]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula-impl.lisp#L139
[b6c9]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L1
[b8e1]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L168
[ad76]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L28
[4961]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L29
[9ae5]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L32
[7309]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L35
[1399]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L41
[d2c8]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L45
[9396]: https://github.com/40ants/cl-brewer/blob/5c886d8613a5fc6b7162fb592d39871d339cf72b/src/formula.lisp#L68
[557c]: https://github.com/40ants/cl-brewer/issues
[f9c6]: https://github.com/benesch/quicklisp-homebrew-roundup
[cccc]: https://github.com/can3p/homebrew-cl-journal/blob/master/cl-journal.rb
Expand Down

0 comments on commit 9175c52

Please sign in to comment.