Changeset 37717 in project


Ignore:
Timestamp:
06/18/19 21:08:20 (4 months ago)
Author:
sjamaan
Message:

Sync wiki manual for 5.1.0 from git

Location:
wiki/man/5
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • wiki/man/5/Acknowledgements

    r35567 r37717  
    2323Gryski, Matt Gushee, Andreas Gustafsson, Sven Hartrumpf, Jun-ichiro
    2424itojun Hagino, Ahdi Hargo, Matthias Heiler, Karl M. Hegbloom, Moritz Heidkamp,
    25 William P. Heinemann, Bill Hoffman, Bruce Hoult, Hans HÃŒbner, Markus HÃŒlsmann,
    26 Götz Isenmann, Paulo Jabardo, Wietse Jacobs, David Janssens, Christian
    27 JÀger, Matt Jones, Dale Jordan, Valentin Kamyshenko, Daishi Kato,
    28 Peter Keller, Christian Kellermann, Brad Kind, Ron Kneusel, "Kooda", Matthias
    29 Köppe, Krysztof Kowalczyk, Andre KÃŒhne, Todd R. Kueny Sr, Goran
     25William P. Heinemann, Bill Hoffman, Eric Hoffman, Bruce Hoult, Hans HÃŒbner,
     26Markus HÃŒlsmann, Götz Isenmann, Paulo Jabardo, Wietse Jacobs, David Janssens,
     27Christian JÀger, Robert Jensen, Matt Jones, Dale Jordan, Valentin Kamyshenko,
     28Daishi Kato, Peter Keller, Christian Kellermann, Brad Kind, Ron Kneusel, "Kooda",
     29Matthias Köppe, Krysztof Kowalczyk, Andre KÃŒhne, Todd R. Kueny Sr, Goran
    3030Krampe, David Krentzlin, Ben Kurtz, Michele La Monaca, Micky
    3131Latowicki, Kristian Lein-Mathisen, "LemonBoy", John Lenz,
  • wiki/man/5/Egg specification format

    r37589 r37717  
    146146
    147147Specifies global options for all programs and extensions compiled for this egg.
    148 {{OPTIONSPEC}} may be {{csc-options}} or {{link-options}} specifications.
     148{{OPTIONSPEC}} may be {{csc-options}}, {{link-options}} or {{linkage}} specifications.
     149
     150==== cond-expand
     151
     152 [egg property] (cond-expand CLAUSE ...)
     153
     154Conditionally expand egg specification forms, depending on system
     155features. Each {{CLAUSE}} should be of the form
     156{{(TEST PROPERTY)}} where {{TEST}} is a feature identifier or a
     157conditional form, in the same syntax as used in the {{cond-expand}}
     158syntactic form.
     159
     160In addition to normal system-wide feature identifiers, feature identifiers
     161given via the {{-feature}} option to {{chicken-install}} are visible in
     162the tests. Also, the features {{target}}, {{host}}, {{dynamic}} and
     163{{static}} are visible, depending on surrounding egg specification
     164forms for constraining mode and linkage.
     165
     166==== error
     167
     168 [egg property] (error STRING ARG ...)
     169
     170Signal an error and abort processing. Mostly useful inside {{cond-expand}} forms.
    149171
    150172=== Components
  • wiki/man/5/Embedding

    r37570 r37717  
    2727 [C function] int CHICKEN_initialize (int heap, int stack, int symbols, void *toplevel)
    2828
    29 Initializes the Scheme execution context and memory. {{heap}}
    30 holds the number of bytes that are to be allocated for the secondary
     29Initializes the Scheme execution context and memory. {{heap}} holds
     30the number of bytes that are to be allocated for the secondary
    3131heap. {{stack}} holds the number of bytes for the primary
    32 heap. {{symbols}} contains the size of the symbol table. Passing
    33 {{0}} to one or more of these parameters will select a default
    34 size.
     32heap. {{symbols}} contains the size of the symbol table. The keyword
     33table will be 1/4th the symbol table size.  Passing {{0}} to one or
     34more of these parameters will select a default size.
     35
    3536{{toplevel}} should be a pointer to the toplevel entry point
    3637procedure. You should pass {{C_toplevel}} here. In any subsequent
  • wiki/man/5/Getting started

    r37569 r37717  
    238238 $ csi
    239239 CHICKEN
    240  (c) 2008-2018, The CHICKEN Team
     240 (c) 2008-2019, The CHICKEN Team
    241241 (c) 2000-2007, Felix L. Winkelmann
    242  Version 5.0.0 (rev 6653dce)
     242 Version 5.1.0 (rev 6653dce)
    243243 linux-unix-gnu-x86-64 [ 64bit dload ptables ]
    244244
  • wiki/man/5/Module (chicken file posix)

    r36352 r37717  
    374374Truncates the file {{FILE}} to the length {{OFFSET}},
    375375which should be an integer. If the file-size is smaller or equal to
    376 {{OFFSET}} then nothing is done.  {{FILE}} should be a filename
    377 or a file-descriptor.
     376{{OFFSET}} then nothing is done.  {{FILE}} should be a filename,
     377a file-descriptor or a port object.
    378378
    379379'''NOTE''': On native Windows builds (all except cygwin), this
  • wiki/man/5/Module (chicken keyword)

    r35529 r37717  
    44== Module (chicken keyword)
    55
    6 Keywords are special symbols prefixed with {{#:}} that evaluate to
    7 themselves. Procedures can use keywords to accept optional named
    8 parameters in addition to normal required parameters. Assignment to
    9 and binding of keyword symbols is not allowed.
     6Keywords are written like symbols, but prefixed with {{#:}}.  They
     7evaluate to themselves. While they behave a lot like symbols in that
     8they are interned when read and can be compared in constant time with
     9{{eq?}}, they are a distinct type.  In particular, they have no plist,
     10they cannot be bound or assigned to and aren't {{eq?}} to a symbol
     11with the same spelling.  Procedures can use keywords to accept
     12optional named parameters in addition to normal required parameters.
    1013
    1114The parameter {{keyword-style}} and the compiler/interpreter option
     
    3942<procedure>(keyword? X)</procedure>
    4043
    41 Returns {{#t}} if {{X}} is a keyword symbol, or {{#f}}
    42 otherwise.
     44Returns {{#t}} if {{X}} is a keyword, or {{#f}} otherwise.
    4345
    4446
  • wiki/man/5/Module (chicken platform)

    r36113 r37717  
    5959(as opposed to the possible locations where they can be loaded or
    6060linked at runtime.)
     61
     62
     63=== system-config-directory
     64
     65<procedure>(system-config-directory)</procedure>
     66
     67Returns the location of the directory for configuration files.  This
     68obeys the XDG specification, so when the {{XDG_CONFIG_HOME}}
     69environment variable is set, its value is used.  When it's not set, it
     70will default to {{$HOME/.config}} on UNIX and {{$APPDATA}} on Windows.
     71
     72
     73=== system-cache-directory
     74
     75<procedure>(system-cache-directory)</procedure>
     76
     77Returns the location of the directory for caches.  This obeys the XDG
     78specification, so when the {{XDG_CACHE_HOME}} environment variable is
     79set, its value is used.  When it's not set, it will default to
     80{{$HOME/.cache}} on UNIX and {{$LOCALAPPDATA}} or {{$APPDATA}} on
     81Windows.
    6182
    6283
  • wiki/man/5/The User's Manual

    r36926 r37717  
    77</nowiki>
    88
    9 This is the manual for CHICKEN Scheme, version 5.0.1
     9This is the manual for CHICKEN Scheme, version 5.1.0
    1010
    1111* [[Getting started]] : What is CHICKEN and how do I use it?
  • wiki/man/5/Types

    r37594 r37717  
    138138<tr><td>{{string}}</td><td>string</td></tr>
    139139<tr><td>{{symbol}}</td><td>symbol</td></tr>
     140<tr><td>{{keyword}}</td><td>keyword object</td></tr>
    140141<tr><td>{{true}}</td><td>boolean true</td></tr>
    141142<tr><td>{{vector}}</td><td>vector</td></tr>
     
    165166
    166167(*) Note: no type-variables are bound inside {{(not TYPE)}}.
     168
     169You can use a shorthand {{'SYMBOL}} for introducing free variables in
     170{{forall}} types, for example:
     171
     172  ('a -> 'a) is translated to (forall (a) (a -> a))
     173
     174If a {{forall}} already exists, quotes around the free variables
     175introduced by it will be stripped:
     176
     177  (forall (a) ('a -> a)) is translated to (forall (a) (a -> a))
    167178
    168179Note that type-variables in {{forall}} types may be given "constraint" types, i.e.
  • wiki/man/5/Using the compiler

    r37689 r37717  
    5151; -emit-external-prototypes-first : Emit prototypes for callbacks defined with {{define-external}} before any other foreign declarations. This is sometimes useful, when C/C++ code embedded into the a Scheme program has to access the callbacks. By default the prototypes are emitted after foreign declarations.
    5252
     53; -regenerate-import-libraries : Always emit new import libraries, even when their contents haven't changed. The default behaviour is to preserve existing import libraries.
     54
    5355; -emit-import-library MODULE : Specifies that an import library named {{MODULE.import.scm}} for the named module should be generated (equivalent to using the {{emit-import-library}} declaration).
    5456
     
    122124; -optimize-leaf-routines : Enable leaf routine optimization.
    123125
    124 ; -optimize-level LEVEL : Enables certain sets of optimization options. {{LEVEL}} should be an integer. Level {{0}} is equivalent to {{-no-usual-integrations -no-compiler-syntax}} (no optimization), level {{1}  is equivalent to {{-optimize-leaf-routines}} (minimal optimization), level {{2}} is equivalent to {{-optimize-leaf-routines -inline}} (enable optimizations that do not break standard compliance, this is the default), level {{3}} is equivalent to {{-optimize-leaf-routines -local -inline -inline-global -specialize}} (maximal optimization, while still "safe"), level {{4}} is equivalent to {{-optimize-leaf-routines -local -inline -inline-global -specialize -unsafe}} (maximal optimization, "unsafe") and any higher level is equivalent to {{-optimize-leaf-routines -block -inline -inline-global -specialize -unsafe -disable-interrupts -no-trace -no-lambda-info -clustering -lfa2}} (all possible optimizations, "unsafe").
     126; -optimize-level LEVEL : Enables certain sets of optimization options. {{LEVEL}} should be an integer. Level {{0}} is equivalent to {{-no-usual-integrations -no-compiler-syntax}} (no optimization), level {{1}  is equivalent to {{-optimize-leaf-routines}} (minimal optimization), level {{2}} is equivalent to {{-optimize-leaf-routines -inline -lfa2}} (enable optimizations that do not break standard compliance, this is the default), level {{3}} is equivalent to {{-optimize-leaf-routines -local -inline -lfa2 -inline-global -specialize}} (maximal optimization, while still "safe"), level {{4}} is equivalent to {{-optimize-leaf-routines -local -inline -lfa2 -inline-global -specialize -unsafe}} (maximal optimization, "unsafe") and any higher level is equivalent to {{-optimize-leaf-routines -block -inline -lfa2 -inline-global -specialize -unsafe -disable-interrupts -no-trace -no-lambda-info -clustering}} (all possible optimizations, "unsafe").
    125127
    126128; -output-file FILENAME : Specifies the pathname of the generated C file. Default is to use the source filename with the extension replaced by {{.c}}.
Note: See TracChangeset for help on using the changeset viewer.