Changeset 21097 in project


Ignore:
Timestamp:
10/27/10 01:28:10 (11 years ago)
Author:
Mario Domenech Goulart
Message:

salmonella (wiki): document some new features

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/salmonella

    r15189 r21097  
    1212a fresh repository, so broken dependencies can be spotted).
    1313
     14Salmonella is used to test the Chicken core source code and all the eggs every day.  You can check the reports at [[http://tests.call-cc.org|tests.call-cc.org]].
     15
     16
    1417=== Some salmonella features:
    1518
     
    2326* Logging and verbosity control
    2427
     28* Execute eggs tests
     29
     30* Check for the existence of wiki documentation for eggs
     31
     32
    2533=== Requirements
     34
     35None
     36
    2637
    2738=== Usage
     
    3142
    3243  Usage: salmonella -h | -help | --help | -?
    33             salmonella <conf-file>
    34             salmonella <options>
     44         salmonella <conf-file>
     45         salmonella <options>
    3546 
    3647  <options> are Scheme expressions. <conf-file> is a file which may
     
    3849  expressions are recognized:
    3950 
    40    == Expression ==                               == Default ==
    41    (chicken-install "<path to chicken-install>")  chicken-install
    42    (chicken-install-args "<args>"                 a procedure which returns "-prefix (repo-test-dir)"
    43    (env-vars "<environment variables settings>"   CHICKEN_REPOSITORY=(repo-test-dir) CHICKEN_INCLUDE_PATH=(repo-test-dir)
    44    (repo-test-dir "<path to repo-test-dir>")      `pwd`/salmonella-repo
     51               == Expression ==                   == Default ==
     52   (csi            \"<path to csi>\")                 csi
     53   (chicken-install \"<path to chicken-install>\")    chicken-install
     54   (chicken-install-args \"<args>\"                 a procedure which returns chicken-install options
     55   (env-vars \"<environment variables settings>\" CHICKEN_INCLUDE_PATH=(repo-test-lib-dir)
     56                                                  CHICKEN_INSTALL_PREFIX=(repo-test-dir)
     57   (repo-test-dir \"<path to repo-test-dir>\")    `pwd`/salmonella-repo
    4558   (chicken-eggs-dir \"<path to SVN dir>\")       `pwd`/chicken-eggs/release/4
    46    (skip-eggs (list "egg1" "egg2" ...))           '()
     59   (wiki-dir \"<path to SVN dir>\")               `pwd`/chicken-eggs/wiki/eggref/4
     60   (skip-eggs (list \"egg1\" \"egg2\" ...))         '()
    4761   (verbose <bool>)                               #f
    48    (logfile "filename")                           salmonella.log
     62   (logfile \"filename\")                         salmonella.log
    4963   (egg-information (lambda () ...))              a procedure which returns egg information for all eggs found in (chicken-eggs-dir)
    5064   (eggs (lambda () ...))                         a procedure which returns the names of all eggs found in (chicken-eggs-dir)
    51    (system-deps "filename")                       #f
    52    (pkg-manager "system pkg manager & args")      #f
     65   (system-deps \"filename\")                     #f
     66   (pkg-manager \"system pkg manager & args\")    #f
    5367   (resume <bool>)                                #f
    5468   (dont-ask <bool>)                              #f
    55    (progress-file "filename")                     salmonella.progress
    56    (html-output "dirname")                        salmonella-report.  If #f, no HTML output
    57    (css-file "filename")                          #f
    58 
     69   (progress-file \"filename\")                   salmonella.progress
     70   (dont-ask <bool>)                              #f
     71   (progress-file \"filename\")                   salmonella.progress
     72   (html-output \"dirname\")                      salmonella-report.  If #f, no HTML output
     73   (dep-graphs-dir \"dirname\")                   (html-output)/dep-graphs
     74   (dep-graphs-webdir \"dirname\")                dep-graphs
     75   (css-file \"filename\")                        #f
     76   (->html \"filename\")                          #f
     77   (base-uri \"uri\")                             /
     78   (run-tests <bool>)                             #f
    5979  Example:
    6080 
    61    salmonella '(chicken-install "/usr/local/chicken/bin/chicken-install") (verbose #t)'
     81   salmonella '(chicken-install \"/usr/local/chicken/bin/chicken-install\") (verbose #t)'
    6282
    6383==== Options
     
    95115is {{#f}}.
    96116
     117* {{chicken-eggs-dir}}: path to the directory containing the source code for eggs
     118
     119* {{wiki-dir}}: path to the directory containing eggs documentation in wiki format
     120
     121* {{run-tests}}: (a boolean) when {{#t}}, indicates that salmonella should execute egg tests.
     122
    97123* {{pkg-manager}}: path to the system package manager and its
    98124  arguments.  It's used with the {{system-deps}} option to install
Note: See TracChangeset for help on using the changeset viewer.