[Openmcl-devel] Interest in documentation reorganization?

[Hamilton Link]

As someone who thought about the need to revamp the documentation at 
one time, but spent zero time actually doing it, my hat goes off to 
you, sir!

Having said that...

I have read most of the implementation notes, about how the garbage 
collector is implemented, the tag bit layout, etc. and find them all 
interesting and important, so thanks for not making those bits 
second-class citizens in some other doc (although certainly putting 
them out of the way towards the end is the Right Thing). If you know of 
any documentation on the compiler intermediate representations, please 
include it as well. If it doesn't exist, perhaps GB and I can bash out 
or at least outline some the next time we get together for lunch (er, 
expect some editing required). I suspect it would be useful when the 
time comes to do dramatic things with the back end.

Please if possible make the doc on the very front page have a link to a 
tarball that unpacks the whole html docs (preferably including the 
latest hyperspec alongside and cross-linked). One gripe I had about the 
hyperspec is it's sometimes real difficult to find a tarball that I can 
suck down and unpack for use when I'm offline. Maybe I can get this by 
doing a CVS checkout but my impression was that it would involve a CVS 
checkout and then a docbook build requiring suitable tools etc.

I believe some people (myself included, if I can find it...) have 
prepared guides to building and using openmcl-compatable nib files from 
interface builder, or building OpenMCL Cocoa bundled apps, such as 
Alpaca. Those would be good to incorporate if you can get your hands on 
them.

Also if you need example code for anything in particular, I have a 
rubix cube app done with OpenGL calls and Cocoa widgets (NSOpenGLView, 
etc.). I could write up something on it (like, related to the process 
of picking the widgets you need, where to find in the Cocoa docs the 
functions you need to override, and how to set up lisp implementations 
of them) and provide you the code to pull selections from as you see 
fit, just let me know what you want.

h

On Jun 1, 2004, at 4:11 PM, Dan Knapp wrote:

> Preface
> 	1. General
> 	2. Obtaining OpenMCL sources
> 	3. Building OpenMCL for LinuxPPC or for DarwinPPC
> 	4. Using OpenMCL
> 	5. Implementation notes
> 	6. OpenMCL's Foreign Function Interface
> 	7. Interface database and translation
> 1. Obtaining, Installing, and Running OpenMCL
> 	1.1. OpenMCL system requirements
> 	1.2. OpenMCL installation
> 	1.3. Using the openmcl shell script
> 	1.4. OpenMCL invocation
> 	1.5. OpenMCL directory organization
> 	1.6. CVS Documentation
> 	1.7. OpenMCL CVS information
> 	1.8. Using ILISP with OpenMCL
> 	1.9. Using ILISP with OpenMCL - old version
> 	1.10. OpenMCL example programs
> 2. Programming with Threads
> 	2.1. Threads in OpenMCL
> 	2.2. Background terminal input in OpenMCL
> 3. Programming with Sockets
> 	3.1. OpenMCL Sockets
> 4. Running Other Programs as Subprocesses
> 	4.1. Running external programs in OpenMCL
> 5. Creating Your Own Stream Classes
> 	5.1. Extending READ-SEQUENCE and WRITE-SEQUENCE
> 	5.2. Multibyte I/O in OpenMCL
> 6. Writing Portable Extensions to the Object System  using the 
> MetaObject Protocol
> 	6.1. Using the MOP in OpenMCL
> 7. The Foreign-Function Interface
> 	7.1. Specifying And Using Foreign Types in OpenMCL
> 	7.2. Foreign Function Calls in OpenMCL
> 	7.3. Referencing and using foreign memory addresses in OpenMCL
> 	7.4. OpenMCL interface database
> 	7.5. Using interface directories in OpenMCL
> 	7.6. Using shared libraries in OpenMCL
> 	7.7. The OpenMCL interface translator
> 	7.8. Case-sensitivity of foreign names in OpenMCL
> 8. Using OpenMCL with Mac OS X, the Darwin Kernel,  and the Cocoa GUI 
> API
> 	8.1. Using OpenMCL under Darwin and MacOS X
> 	8.2. Cocoa Programming in OpenMCL
> 	8.3. Line termination in OpenMCL
> 9. Understanding and Configuring the Garbage Collector
> 	9.1. OpenMCL memory usage
> 10. Rebuilding and Developing OpenMCL Itself
> 	10.1. Building OpenMCL's heap image
> 	10.2. OpenMCL kernel build procedure
> 	10.3. Using OpenMCL in "development" and in "user" mode
> 	10.4. Debugging facilities in the lisp kernel
> 	10.5. Using AltiVec in OpenMCL LAP functions
> 	10.6. OpenMCL implementation notes
>