mirrors/ecl
1
Fork 0
mirror of https://gitlab.com/embeddable-common-lisp/ecl.git synced 2026-01-16 22:32:05 -08:00
Code Issues Projects Releases Packages Wiki Activity

Improve examples in the manual

Browse source
This commit is contained in:
Kevin Zheng 2024-02-15 10:51:30 -08:00
parent 38a2e31e45
commit a0e02e81ba
2 changed files with 34 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

39
src/doc/manual/extensions/building.txi
View file

@ -302,12 +302,15 @@ format. In case of @emph{Portable FASL} the bytecodes compiler is needed.
@node Compiling with ASDF
@subsection Compiling with ASDF
First, let's disregard the simple situation in which we write Lisp
without depending on any other Lisp libraries. A more practical example
is to build a library that depends on other
@uref{https://common-lisp.net/project/asdf/,asdf}, systems. ECL provides
a useful extension for asdf called @code{asdf:make-build}, which offers
an abstraction for building libraries directly from system definitions.
For larger systems involving more complex file dependencies, or for systems
that are portable across different Common Lisp implementations, it may be
better to define systems using @uref{https://common-lisp.net/project/asdf/,asdf}.
ECL provides a useful extension for asdf called @code{asdf:make-build}, which
offers an abstraction for building libraries directly from system definitions.
Note that this extension is only available in the ASDF that is shipped with
ECL; it may not be available from an ASDF installed from the system or from
Quicklisp.
To download dependencies you may use
@uref{https://www.quicklisp.org,Quicklisp} to load your system (with
@ -328,14 +331,22 @@ the fact that other libraries may be loaded).
@node Example code to build
@subsubsection Example code to build
We use a simple project that depends on @code{alexandria} to
demonstrate the interface. The example consists of
@code{example-with-dep.asd}, @code{package.lisp} and
@code{example.lisp} (included in the
@code{examples/asdf_with_dependence/} directory in the ECL source
tree). Before any kind of build you need to push the full path of
this directory to @code{asdf:*central-registry*} (or link it in a
location already recognized by ASDF).
An example project is included in the ECL source distribution in the
@code{examples/asdf_with_dependence/} directory.
This project depends on the @code{alexandria} library and consists of a system
definition (@code{example-with-dep.asd}), package definition
(@code{package.lisp}), and the actual library code (@code{example.lisp}).
Before following the steps below, you must
@uref{https://asdf.common-lisp.dev/asdf/Configuring-ASDF-to-find-your-systems.html,configure ASDF to find your systems}.
You can either copy or symlink the example directory in one of the standard
ASDF locations, or push the path of the example directory to your
@code{asdf:*central-registry*}, for example:
@lisp
(push "./" asdf:*central-registry*)
@end lisp
@node Build it as an single executable
@subsubsection Build it as an single executable

11
src/doc/manual/user-guide/embedding.txi
View file

@ -5,8 +5,15 @@
* Embedding ECL - Embedding Reference::
@end menu
@c @node Embedding ECL - Introduction
@c @subsection Introduction
@subsection Minimal Example
An example project is included in the ECL source distribution in the
@code{examples/embed/} directory.
This example consists of a Common Lisp library (@code{hello-lisp.lisp}) and a
system definition (@code{hello-lisp.asd}, @xref{Compiling with ASDF}) that is
called from a C program (@code{hello.c}). The example @code{Makefile} shows how
to build a static library from the Lisp library and link it with the C program.
@node Embedding ECL - Embedding Reference
@subsection Embedding Reference