source: trunk/abcl/README @ 14866

Last change on this file since 14866 was 14866, checked in by Mark Evenson, 6 years ago

metadata: reverse previous edit, start annotating for 1.4.0-rc-1

  • Property svn:eol-style set to native
File size: 7.4 KB
Line 
1Armed Bear Common Lisp README
2=============================
3
4GENERAL INFORMATION
5-------------------
6
7Armed Bear Common Lisp is a conforming implementation of ANSI Common
8Lisp that runs in a Java virtual machine.  It compiles Lisp code
9directly to Java byte code.
10
11
12LICENSE
13=======
14
15Armed Bear Common Lisp is distributed under the GNU General Public
16License with a classpath exception (see "Classpath Exception" below).
17
18A copy of GNU General Public License (GPL) is included in this
19distribution, in the file COPYING.
20
21Linking this software statically or dynamically with other modules is
22making a combined work based on this software. Thus, the terms and
23conditions of the GNU General Public License cover the whole
24combination.
25
26** Classpath Exception
27
28As a special exception, the copyright holders of this software give
29you permission to link this software with independent modules to
30produce an executable, regardless of the license terms of these
31independent modules, and to copy and distribute the resulting
32executable under terms of your choice, provided that you also meet,
33for each linked independent module, the terms and conditions of the
34license of that module. An independent module is a module which is not
35derived from or based on this software. If you modify this software,
36you may extend this exception to your version of the software, but you
37are not obligated to do so. If you do not wish to do so, delete this
38exception statement from your version.
39
40
41RUNNING FROM BINARY RELEASE
42===========================
43
44After you have downloaded a binary release archive unpack it into its
45own directory. To run ABCL directly from this directory, make sure
46Java (version 1.5 or up) is in your shell's path. Then issue the
47following command:
48
49    cmd$ java -jar abcl.jar
50
51which should result in output like the following
52
53    Armed Bear Common Lisp 1.4.0-dev
54    Java 1.7.0_51 Sun Microsystems Inc.
55    Java HotSpot(TM) Client VM
56    Low-level initialization completed in 0.3 seconds.
57    Startup completed in 2.294 seconds.
58    Type ":help" for a list of available commands.
59    CL-USER(1):
60
61
62BUILDING FROM SOURCE RELEASE
63============================
64
65There are three ways to build ABCL from the source release with the
66preferred (and most tested way) is to being to use the Ant build tool:
67
68* Use the Ant build tool for Java environments.
69
70* Use the NetBeans [678].x IDE to open ABCL as a project.
71
72* Bootstrap ABCL using a Common Lisp implementation. Supported
73  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
74  CL, LispWorks or CLISP.
75
76In all cases you need a Java 5 or later JDK (JDK 1.[567] have been
77tested).  Just the JRE isn't enough, as you need the Java compiler
78('javac') to compile the Java source of the ABCL implementation.
79
80Note that when deploying ABCL having JDK isn't a requirement for the
81installation site, just the equivalent JRE, as ABCL compiles directly
82to byte code, avoiding the need for the 'javac' compiler in deployment
83environments.
84
85
86Using Ant
87---------
88
89Download a binary distribution [Ant version 1.7.1 or greater][1].
90Unpack the files somewhere convenient, ensuring that the 'ant' (or
91'ant.bat' under Windows) executable is in your path and executable.
92
93[1]: http://ant.apache.org/bindownload.cgi
94
95Then simply executing
96
97    unix$ ant
98
99or
100
101    dos> ant.bat
102
103from the directory containing this README file will create an
104executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
105this wrapper to start ABCL.
106
107
108Using NetBeans
109--------------
110
111Obtain and install the [NetBeans IDE][2]. One should be able to open
112the ABCL directory as a project in the Netbeans application, whereupon
113the usual build, run, and debug targets as invoked in the GUI are
114available.  Use the 'slime' config with a suitably linked 'swank.asd'
115in '~/.asdf-install-dir/systems/' to connect a REPL to the NetBeans
116debug process.
117
118[2]: http://netbeans.org/downloads/
119
120
121Building from Lisp
122------------------
123
124Building from another Common Lisp implementation is the most venerable
125and least tested way of building ABCL.  It produces a "non-standard"
126version of the distribution that doesn't share build instructions with
127the previous two methods, but it still may be of interest to those who
128absolutely don't want to know anything about Java.  The other Common
129Lisp implementation does not actually perform any compliation, but is
130merely used to orchestrate the invocation of tools in the JDK.
131
132First, copy the file 'customizations.lisp.in' to 'customization.lisp',
133in the directory containing this README file, editing to suit your
134situation, paying attention to the comments in the file.  The critical
135step is to have Lisp special variable '*JDK*' point to the root of the
136Java Development Kit.  Underneath the directory referenced by the
137value of '*JDK*' there should be an executable Java compiler in
138'bin/javac' ('bin/javac.exe' under Windows).
139
140Then, one may either use the 'build-from-lisp.bash' shell script or load
141the necessary files into your Lisp image by hand.
142
143** Using the 'build-from-lisp.bash' script
144
145Under UNIX-like systems, one may simply invoke the
146'build-from-lisp.bash' script.  As noted above, one must first copy the
147'customizations.lisp.in' file to 'customizations.lisp', then edit it
148to reflect the local configuration most importantly the path to the
149Java Development Kit.
150
151After configuring 'customizations.lisp', the following would use SBCL
152as the compilation driver to build ABCL:
153
154    unix$ ./build-from-lisp.bash sbcl
155
156After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
157to start ABCL.  Note that this wrappers contain absolute paths, so
158you'll need to edit them if you move things around after the build.
159
160If you're developing on ABCL, you may want to use
161
162    unix$ ./build-from-lisp.bash <implementation> --clean=nil
163
164to not do a full rebuild.
165
166In case of failure in the javac stage, you might try this:
167
168    unix$ ./build-from-lisp.bash <implementation> --full=t --clean=t --batch=nil
169
170This invokes javac separately for each .java file, which avoids running
171into limitations on command line length (but is a lot slower).
172
173** Building from another Lisp manually
174
175There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
176which can be used to load the necessary Lisp definitions, after which
177
178    CL-USER> (build-abcl:build-abcl :clean t :full t)
179
180will build ABCL.  If ASDF isn't present, simply LOAD the
181'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
182effect as loading the ASDF definition.
183
184
185BUGS
186====
187
188ABCL is a conforming ANSI Common Lisp implementation.  Any other
189behavior should be reported as a bug.
190
191ABCL now has a manual stating its conformance to the ANSI standard,
192providing a compliant and practical Common Lisp implementation.
193Because of this,
194
195
196### Tests
197
198ABCL 1.4.0 now fails only 1[2-4] out of 21708 total tests in the ANSI CL
199test suite (derived from the tests originally written for GCL).
200
201Maxima's test suite runs without failures.
202
203ABCL comes with a test suite, see the output of `ant help.test` for more
204information.
205
206### Deficiencies
207
208The MOP implementation is incompletel untested.
209
210Patches to address any of the issues mentioned above will
211be gladly accepted.
212
213# Contact
214
215Please report problems to the development mailing list:
216
217    <armedbear-devel@common-lisp.net>
218
219Have fun!
220
221# Authors
222
223On behalf of all ABCL development team and contributors,
224
225    Mark Evenson
226    Erik Huelsmann
227    Rudolf Schlatte
228    Alessio Stalla
229    Ville Voutilainen
230
231    ferada
232    olof
233    pipping
234    slyrus
235
236September 2016
237
238
Note: See TracBrowser for help on using the repository browser.