Commit c33f7ac8 authored by Philipp Marek's avatar Philipp Marek

Documentation updates.

parent dd5607a2
......@@ -41,12 +41,18 @@ Documentation:
Patches:
Patches are always welcome! Please send them to the mailing list as
attachments, generated by "git format-patch -1".
Patches are always welcome! Please prepare pull requests in
gitlab, though we also can pull branches off github.
Patches should include a commit message that explains what's being
done and /why/, and when fixing a bug or adding a feature you should
also include a test-case.
Be advised though that right now new features are unlikely to be
accepted until 1.0 is officially out of the door.
Be advised that the ALEXANDRIA-1 package is frozen; there are so many
existing users that any newly exported symbols are likely to break
someone's code.
For that reason an ALEXANDRIA-2 package is now open for additions;
to make switching over easier it will include all the symbols from
ALEXANDRIA-1 as well [just change your (:USE ALEXANDRIA) to
(:USE ALEXANDRIA-2) to get the new functions in your package].
......@@ -15,7 +15,7 @@ include:
sbcl --no-userinit --eval '(require :asdf)' \
--eval '(let ((asdf:*central-registry* (list "../"))) (require :alexandria))' \
--load docstrings.lisp \
--eval '(sb-texinfo:generate-includes "include/" (list :alexandria) :base-package :alexandria)' \
--eval '(sb-texinfo:generate-includes "include/" (list :alexandria-2) :base-package :alexandria-2)' \
--eval '(quit)'
pdf: include
......
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename alexandria.info
@settitle Alexandria Manual
@settitle Alexandria-2 Manual
@c %**end of header
@settitle Alexandria Manual -- draft version
@settitle Alexandria-2 Manual -- draft version
@c for install-info
@dircategory Software development
......@@ -58,7 +58,7 @@ terms and conditions:
@titlepage
@title Alexandria Manual
@title Alexandria-2 Manual
@subtitle draft version
@c The following two commands start the copyright page.
......@@ -99,179 +99,180 @@ terms and conditions:
@comment node-name, next, previous, up
@chapter Hash Tables
@include include/macro-alexandria-ensure-gethash.texinfo
@include include/fun-alexandria-copy-hash-table.texinfo
@include include/fun-alexandria-maphash-keys.texinfo
@include include/fun-alexandria-maphash-values.texinfo
@include include/fun-alexandria-hash-table-keys.texinfo
@include include/fun-alexandria-hash-table-values.texinfo
@include include/fun-alexandria-hash-table-alist.texinfo
@include include/fun-alexandria-hash-table-plist.texinfo
@include include/fun-alexandria-alist-hash-table.texinfo
@include include/fun-alexandria-plist-hash-table.texinfo
@include include/macro-alex-2-ensure-gethash.texinfo
@include include/fun-alex-2-copy-hash-table.texinfo
@include include/fun-alex-2-maphash-keys.texinfo
@include include/fun-alex-2-maphash-values.texinfo
@include include/fun-alex-2-hash-table-keys.texinfo
@include include/fun-alex-2-hash-table-values.texinfo
@include include/fun-alex-2-hash-table-alist.texinfo
@include include/fun-alex-2-hash-table-plist.texinfo
@include include/fun-alex-2-alist-hash-table.texinfo
@include include/fun-alex-2-plist-hash-table.texinfo
@node Data and Control Flow
@comment node-name, next, previous, up
@chapter Data and Control Flow
@include include/macro-alexandria-define-constant.texinfo
@include include/macro-alexandria-destructuring-case.texinfo
@include include/macro-alexandria-ensure-functionf.texinfo
@include include/macro-alexandria-multiple-value-prog2.texinfo
@include include/macro-alexandria-named-lambda.texinfo
@include include/macro-alexandria-nth-value-or.texinfo
@include include/macro-alexandria-if-let.texinfo
@include include/macro-alexandria-when-let.texinfo
@include include/macro-alexandria-when-let-star.texinfo
@include include/macro-alexandria-switch.texinfo
@include include/macro-alexandria-cswitch.texinfo
@include include/macro-alexandria-eswitch.texinfo
@include include/macro-alexandria-whichever.texinfo
@include include/macro-alexandria-xor.texinfo
@include include/fun-alexandria-disjoin.texinfo
@include include/fun-alexandria-conjoin.texinfo
@include include/fun-alexandria-compose.texinfo
@include include/fun-alexandria-ensure-function.texinfo
@include include/fun-alexandria-multiple-value-compose.texinfo
@include include/fun-alexandria-curry.texinfo
@include include/fun-alexandria-rcurry.texinfo
@include include/macro-alex-2-define-constant.texinfo
@include include/macro-alex-2-destructuring-case.texinfo
@include include/macro-alex-2-ensure-functionf.texinfo
@include include/macro-alex-2-multiple-value-prog2.texinfo
@include include/macro-alex-2-named-lambda.texinfo
@include include/macro-alex-2-nth-value-or.texinfo
@include include/macro-alex-2-if-let.texinfo
@include include/macro-alex-2-when-let.texinfo
@include include/macro-alex-2-when-let-star.texinfo
@include include/macro-alex-2-switch.texinfo
@include include/macro-alex-2-cswitch.texinfo
@include include/macro-alex-2-eswitch.texinfo
@include include/macro-alex-2-whichever.texinfo
@include include/macro-alex-2-xor.texinfo
@include include/fun-alex-2-disjoin.texinfo
@include include/fun-alex-2-conjoin.texinfo
@include include/fun-alex-2-compose.texinfo
@include include/fun-alex-2-ensure-function.texinfo
@include include/fun-alex-2-multiple-value-compose.texinfo
@include include/fun-alex-2-curry.texinfo
@include include/fun-alex-2-rcurry.texinfo
@node Conses
@comment node-name, next, previous, up
@chapter Conses
@include include/type-alexandria-proper-list.texinfo
@include include/type-alexandria-circular-list.texinfo
@include include/macro-alexandria-appendf.texinfo
@include include/macro-alexandria-nconcf.texinfo
@include include/macro-alexandria-remove-from-plistf.texinfo
@include include/macro-alexandria-delete-from-plistf.texinfo
@include include/macro-alexandria-reversef.texinfo
@include include/macro-alexandria-nreversef.texinfo
@include include/macro-alexandria-unionf.texinfo
@include include/macro-alexandria-nunionf.texinfo
@include include/macro-alexandria-doplist.texinfo
@include include/fun-alexandria-circular-list-p.texinfo
@include include/fun-alexandria-circular-tree-p.texinfo
@include include/fun-alexandria-proper-list-p.texinfo
@include include/fun-alexandria-alist-plist.texinfo
@include include/fun-alexandria-plist-alist.texinfo
@include include/fun-alexandria-circular-list.texinfo
@include include/fun-alexandria-make-circular-list.texinfo
@include include/fun-alexandria-ensure-car.texinfo
@include include/fun-alexandria-ensure-cons.texinfo
@include include/fun-alexandria-ensure-list.texinfo
@include include/fun-alexandria-flatten.texinfo
@include include/fun-alexandria-lastcar.texinfo
@include include/fun-alexandria-setf-lastcar.texinfo
@include include/fun-alexandria-proper-list-length.texinfo
@include include/fun-alexandria-mappend.texinfo
@include include/fun-alexandria-map-product.texinfo
@include include/fun-alexandria-remove-from-plist.texinfo
@include include/fun-alexandria-delete-from-plist.texinfo
@include include/fun-alexandria-set-equal.texinfo
@include include/fun-alexandria-setp.texinfo
@include include/type-alex-2-proper-list.texinfo
@include include/type-alex-2-circular-list.texinfo
@include include/macro-alex-2-appendf.texinfo
@include include/macro-alex-2-nconcf.texinfo
@include include/macro-alex-2-remove-from-plistf.texinfo
@include include/macro-alex-2-delete-from-plistf.texinfo
@include include/macro-alex-2-reversef.texinfo
@include include/macro-alex-2-nreversef.texinfo
@include include/macro-alex-2-unionf.texinfo
@include include/macro-alex-2-nunionf.texinfo
@include include/macro-alex-2-doplist.texinfo
@include include/fun-alex-2-circular-list-p.texinfo
@include include/fun-alex-2-circular-tree-p.texinfo
@include include/fun-alex-2-proper-list-p.texinfo
@include include/fun-alex-2-alist-plist.texinfo
@include include/fun-alex-2-plist-alist.texinfo
@include include/fun-alex-2-circular-list.texinfo
@include include/fun-alex-2-make-circular-list.texinfo
@include include/fun-alex-2-ensure-car.texinfo
@include include/fun-alex-2-ensure-cons.texinfo
@include include/fun-alex-2-ensure-list.texinfo
@include include/fun-alex-2-flatten.texinfo
@include include/fun-alex-2-lastcar.texinfo
@include include/fun-alex-2-setf-lastcar.texinfo
@include include/fun-alex-2-proper-list-length.texinfo
@include include/fun-alex-2-mappend.texinfo
@include include/fun-alex-2-map-product.texinfo
@include include/fun-alex-2-remove-from-plist.texinfo
@include include/fun-alex-2-delete-from-plist.texinfo
@include include/fun-alex-2-delete-from-plist*.texinfo
@include include/fun-alex-2-set-equal.texinfo
@include include/fun-alex-2-setp.texinfo
@node Sequences
@comment node-name, next, previous, up
@chapter Sequences
@include include/type-alexandria-proper-sequence.texinfo
@include include/macro-alexandria-deletef.texinfo
@include include/macro-alexandria-removef.texinfo
@include include/fun-alexandria-rotate.texinfo
@include include/fun-alexandria-shuffle.texinfo
@include include/fun-alexandria-random-elt.texinfo
@include include/fun-alexandria-emptyp.texinfo
@include include/fun-alexandria-sequence-of-length-p.texinfo
@include include/fun-alexandria-length-equals.texinfo
@include include/fun-alexandria-copy-sequence.texinfo
@include include/fun-alexandria-first-elt.texinfo
@include include/fun-alexandria-setf-first-elt.texinfo
@include include/fun-alexandria-last-elt.texinfo
@include include/fun-alexandria-setf-last-elt.texinfo
@include include/fun-alexandria-starts-with.texinfo
@include include/fun-alexandria-starts-with-subseq.texinfo
@include include/fun-alexandria-ends-with.texinfo
@include include/fun-alexandria-ends-with-subseq.texinfo
@include include/fun-alexandria-map-combinations.texinfo
@include include/fun-alexandria-map-derangements.texinfo
@include include/fun-alexandria-map-permutations.texinfo
@include include/type-alex-2-proper-sequence.texinfo
@include include/macro-alex-2-deletef.texinfo
@include include/macro-alex-2-removef.texinfo
@include include/fun-alex-2-rotate.texinfo
@include include/fun-alex-2-shuffle.texinfo
@include include/fun-alex-2-random-elt.texinfo
@include include/fun-alex-2-emptyp.texinfo
@include include/fun-alex-2-sequence-of-length-p.texinfo
@include include/fun-alex-2-length-equals.texinfo
@include include/fun-alex-2-copy-sequence.texinfo
@include include/fun-alex-2-first-elt.texinfo
@include include/fun-alex-2-setf-first-elt.texinfo
@include include/fun-alex-2-last-elt.texinfo
@include include/fun-alex-2-setf-last-elt.texinfo
@include include/fun-alex-2-starts-with.texinfo
@include include/fun-alex-2-starts-with-subseq.texinfo
@include include/fun-alex-2-ends-with.texinfo
@include include/fun-alex-2-ends-with-subseq.texinfo
@include include/fun-alex-2-map-combinations.texinfo
@include include/fun-alex-2-map-derangements.texinfo
@include include/fun-alex-2-map-permutations.texinfo
@node IO
@comment node-name, next, previous, up
@chapter IO
@include include/fun-alexandria-read-stream-content-into-string.texinfo
@include include/fun-alexandria-read-file-into-string.texinfo
@include include/fun-alexandria-read-stream-content-into-byte-vector.texinfo
@include include/fun-alexandria-read-file-into-byte-vector.texinfo
@include include/fun-alex-2-read-stream-content-into-string.texinfo
@include include/fun-alex-2-read-file-into-string.texinfo
@include include/fun-alex-2-read-stream-content-into-byte-vector.texinfo
@include include/fun-alex-2-read-file-into-byte-vector.texinfo
@node Macro Writing
@comment node-name, next, previous, up
@chapter Macro Writing
@include include/macro-alexandria-once-only.texinfo
@include include/macro-alexandria-with-gensyms.texinfo
@include include/macro-alexandria-with-unique-names.texinfo
@include include/fun-alexandria-featurep.texinfo
@include include/fun-alexandria-parse-body.texinfo
@include include/fun-alexandria-parse-ordinary-lambda-list.texinfo
@include include/macro-alex-2-once-only.texinfo
@include include/macro-alex-2-with-gensyms.texinfo
@include include/macro-alex-2-with-unique-names.texinfo
@include include/fun-alex-2-featurep.texinfo
@include include/fun-alex-2-parse-body.texinfo
@include include/fun-alex-2-parse-ordinary-lambda-list.texinfo
@node Symbols
@comment node-name, next, previous, up
@chapter Symbols
@include include/fun-alexandria-ensure-symbol.texinfo
@include include/fun-alexandria-format-symbol.texinfo
@include include/fun-alexandria-make-keyword.texinfo
@include include/fun-alexandria-make-gensym.texinfo
@include include/fun-alexandria-make-gensym-list.texinfo
@include include/fun-alexandria-symbolicate.texinfo
@include include/fun-alex-2-ensure-symbol.texinfo
@include include/fun-alex-2-format-symbol.texinfo
@include include/fun-alex-2-make-keyword.texinfo
@include include/fun-alex-2-make-gensym.texinfo
@include include/fun-alex-2-make-gensym-list.texinfo
@include include/fun-alex-2-symbolicate.texinfo
@node Arrays
@comment node-name, next, previous, up
@chapter Arrays
@include include/type-alexandria-array-index.texinfo
@include include/type-alexandria-array-length.texinfo
@include include/fun-alexandria-copy-array.texinfo
@include include/type-alex-2-array-index.texinfo
@include include/type-alex-2-array-length.texinfo
@include include/fun-alex-2-copy-array.texinfo
@node Types
@comment node-name, next, previous, up
@chapter Types
@include include/type-alexandria-string-designator.texinfo
@include include/macro-alexandria-coercef.texinfo
@include include/fun-alexandria-of-type.texinfo
@include include/fun-alexandria-type-equals.texinfo
@include include/type-alex-2-string-designator.texinfo
@include include/macro-alex-2-coercef.texinfo
@include include/fun-alex-2-of-type.texinfo
@include include/fun-alex-2-type-equals.texinfo
@node Numbers
@comment node-name, next, previous, up
@chapter Numbers
@include include/macro-alexandria-maxf.texinfo
@include include/macro-alexandria-minf.texinfo
@include include/fun-alexandria-binomial-coefficient.texinfo
@include include/fun-alexandria-count-permutations.texinfo
@include include/fun-alexandria-clamp.texinfo
@include include/fun-alexandria-lerp.texinfo
@include include/fun-alexandria-factorial.texinfo
@include include/fun-alexandria-subfactorial.texinfo
@include include/fun-alexandria-gaussian-random.texinfo
@include include/fun-alexandria-iota.texinfo
@include include/fun-alexandria-map-iota.texinfo
@include include/fun-alexandria-mean.texinfo
@include include/fun-alexandria-median.texinfo
@include include/fun-alexandria-variance.texinfo
@include include/fun-alexandria-standard-deviation.texinfo
@include include/macro-alex-2-maxf.texinfo
@include include/macro-alex-2-minf.texinfo
@include include/fun-alex-2-binomial-coefficient.texinfo
@include include/fun-alex-2-count-permutations.texinfo
@include include/fun-alex-2-clamp.texinfo
@include include/fun-alex-2-lerp.texinfo
@include include/fun-alex-2-factorial.texinfo
@include include/fun-alex-2-subfactorial.texinfo
@include include/fun-alex-2-gaussian-random.texinfo
@include include/fun-alex-2-iota.texinfo
@include include/fun-alex-2-map-iota.texinfo
@include include/fun-alex-2-mean.texinfo
@include include/fun-alex-2-median.texinfo
@include include/fun-alex-2-variance.texinfo
@include include/fun-alex-2-standard-deviation.texinfo
@bye
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment