Skip to content

Commit

Permalink
Update the Common Lisp -> Emacs Lisp bridge's documentation.
Browse files Browse the repository at this point in the history
2015-11-24  Didier Verna  <didier@didierverna.net>

	* doc/user.texi (Installation):
	(Configuration): Update for the Emacs Lisp library.
	* INSTALL: Regenerate.
  • Loading branch information
didierverna committed Nov 24, 2015
1 parent 2f7aef0 commit 5d9592e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 19 deletions.
23 changes: 14 additions & 9 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ compiler in your init file. Otherwise, Clon will run in restricted mode

In addition to the library itself, the Clon distribution offers
documentation in the form of 3 different manuals, some data files like
sample themes (*note (clon-enduser)Theme Creation::), and a couple of
demonstration programs. If you want to benefit from all those wonders,
some bits of manual installation are needed. After unpacking somewhere
in the ASDF 3 source registry, please perform the following steps, in
order.
sample themes (*note (clon-enduser)Theme Creation::), a couple of
demonstration programs and an Emacs Lisp library for supporting the
development. If you want to benefit from all those wonders, some bits
of manual installation are needed. After unpacking somewhere in the
ASDF 3 source registry, please perform the following steps, in order.

1. Edit ‘make/config.make’ to your specific needs.

Expand Down Expand Up @@ -78,10 +78,15 @@ specific options with the following function.
information for some of its functions directly embedded in the
code. This information can be automatically transmitted to
(X)Emacs when the ASDF system is loaded if you set this option to
‘t’. However, note that for this to work, the Slime variable
‘slime-enable-evaluate-in-emacs’ must also be set to ‘t’ in your
(X)Emacs session. If you’re interested to know how this process
works, I have described it in the following blog entry:
‘t’. For this to work, there are two things to do first in your
(X)Emacs session:
1. set the Slime variable ‘slime-enable-evaluate-in-emacs’ to
‘t’,
2. and load the ‘clon’ Emacs Lisp library. This library is part
of the distribution and installed in a standard Emacs Lisp
directory by ‘make install’.
If you’re interested to know how this process works, I have
described it in the following blog entry:
<http://www.didierverna.com/sciblog/index.php?post/2011/07/20/One-more-indentation-hack>.
:restricted
Some non-ANSI features of Clon require external functionality that
Expand Down
28 changes: 18 additions & 10 deletions doc/user.texi
Original file line number Diff line number Diff line change
Expand Up @@ -557,11 +557,11 @@ mode (@pxref{Technical Notes}). For instance, put this in your

In addition to the library itself, the @clon{} distribution offers
documentation in the form of 3 different manuals, some data files like
sample themes (@pxenduserref{Theme Creation}), and a couple of
demonstration programs. If you want to benefit from all those wonders,
some bits of manual installation are needed. After unpacking somewhere
in the ASDF 3 source registry, please perform the following steps, in
order.
sample themes (@pxenduserref{Theme Creation}), a couple of demonstration
programs and an Emacs Lisp library for supporting the development. If
you want to benefit from all those wonders, some bits of manual
installation are needed. After unpacking somewhere in the ASDF 3 source
registry, please perform the following steps, in order.

@enumerate
@item
Expand Down Expand Up @@ -2679,11 +2679,19 @@ This option is only useful if you use Slime, and mostly if you plan on
hacking @clon{} itself. The library provides indentation information for
some of its functions directly embedded in the code. This information
can be automatically transmitted to (X)Emacs when the ASDF system is
loaded if you set this option to @code{t}. However, note that for this
to work, the Slime variable @code{slime-enable-evaluate-in-emacs} must
also be set to @code{t} in your (X)Emacs session. If you're interested
to know how this process works, I have described it in the following
blog entry:
loaded if you set this option to @code{t}. For this to work, there are
two things to do first in your (X)Emacs session:
@enumerate
@item
set the Slime variable @code{slime-enable-evaluate-in-emacs} to
@code{t},
@item
and load the @file{clon} Emacs Lisp library. This library is part of the
distribution and installed in a standard Emacs Lisp directory by
@samp{make install}.
@end enumerate
If you're interested to know how this process works, I have described it
in the following blog entry:
@uref{http://www.didierverna.com/sciblog/index.php?post/2011/07/20/One-more-indentation-hack}.
@item :restricted
@coindex{restricted}@c
Expand Down

0 comments on commit 5d9592e

Please sign in to comment.