Actions

Difference between revisions of "Internal Documentation"

From Gambit wiki

m (Copied from old wiki)
 
m (Fixed a typo, prevented undesirable markup, added an explanation.)
Line 27: Line 27:
  
 
==== Variables ====
 
==== Variables ====
;##repl-location-relative
+
;<code>##repl-location-relative</code>
 
:Should the REPL give relative or absolute pathnames.  '''Note:''' When using emacs with gambit, it is useful to set it to #f, especially if you change the current-directory.
 
:Should the REPL give relative or absolute pathnames.  '''Note:''' When using emacs with gambit, it is useful to set it to #f, especially if you change the current-directory.
 
   
 
   
 
==== Functions ====
 
==== Functions ====
;##cmd-''x''
+
;<code>##cmd-</code>''x''
:where ''x'' is an repl command.  Executes that command as if it was executed inside of the REPL.  For instance ##cmd-b displays a backtrace.
+
:where ''x'' is a REPL command letter (typed after a comma from the REPL).  Executes that command as if it was executed inside of the REPL.  For instance <code>##cmd-b</code> displays a backtrace.
  
 
== Compiler ==
 
== Compiler ==

Revision as of 05:06, 23 March 2008

People who want to contribute to Gambit development will need to learn something about how the Gambit-C runtime and compiler are organized. While we intend that source code documentation be included in the source itself (currently there is very little documentation), we intend that descriptions of program design or algorithms used in the runtime and compiler could be included here.

Namespace handling

See Namespaces.

Runtime Library

Memory Management

Phil Dawes has put together some notes on memory management.

Thread System

I/O System

Arithmetic implementation

Eval

REPL

The REPL has some fairly interesting functions and variables, especially for hackers.

Variables

##repl-location-relative
Should the REPL give relative or absolute pathnames. Note: When using emacs with gambit, it is useful to set it to #f, especially if you change the current-directory.

Functions

##cmd-x
where x is a REPL command letter (typed after a comma from the REPL). Executes that command as if it was executed inside of the REPL. For instance ##cmd-b displays a backtrace.

Compiler