In-source documentation for Chicken scheme
Scheme
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
README.org
TODO.org
cock.meta
cock.release-info
cock.scm
cock.setup
cock.wiki

README.org

Abstract

Cock provides in-source documentation for Chicken scheme; it currently targets PDF-over-LaTeX, but we’d like to add svnwiki and maybe HTML.

Using cock

Cock uses reader macros, which work out-of-the-box in interpreted code; simply:

(use cock)
  

Compiled code, on the other hand, requires passing an option to the compiler in addition to the use statement:

-X cock
  

(This issue with using reader-macros in compiled code is documented here and here.)

If you’re using autocompile to run Chicken scripts, set the environment accordingly:

CHICKEN_SCHEME_OPTIONS="-X cock" ./your-chicken-script.scm  
  

Similarly, in your egg .setup file, try:

(compile -X cock -d0 -O2 -J -s "example.scm")  
  

or if you use setup-helper:

(setup-shared-extension-module
 'example
 '(version "0.0.1")
 compile-options: '(-X cock))