Changeset 15150 in project


Ignore:
Timestamp:
07/04/09 07:29:58 (11 years ago)
Author:
Ivan Raikov
Message:

added salmonella 4 doc

File:
1 copied

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/salmonella

    r15095 r15150  
    33== Salmonella -- a tool for testing Chicken eggs
    44
    5 Salmonella is a tool for testing Chicken eggs from the official repository.
     5Salmonella is a tool for testing Chicken eggs from a local or remote
     6repository.
    67
    7 Salmonella fetches the eggs repository listing from
    8 http://www.call-with-current-continuation.org/eggs and tries to
    9 install each egg, reporting failure or success.  Each egg is
    10 individually tested, that is, salmonella sets the local destination repository
    11 empty before testing an egg (it's like installing an egg on a fresh
    12 repository, so broken dependencies can be spotted).
     8Salmonella fetches a list of eggs from a local egg repository, or from
     9a server via the henrietta script, and tries to install each egg,
     10reporting failure or success.  Each egg is individually tested, that
     11is, salmonella sets the local destination repository empty before
     12testing an egg (it's like installing an egg on a fresh repository, so
     13broken dependencies can be spotted).
    1314
    1415=== Some salmonella features:
     
    1819* Resuming
    1920
    20 * Possibility of hooking system's package manager (e.g., apt, rpm) for installing OS packages eggs might depend on
     21* Possibility of hooking system's package manager (e.g., apt, rpm) for
     22  installing OS packages eggs might depend on
    2123
    2224* Logging and verbosity control
    2325
    2426=== Requirements
    25 
    26 * [[http]] egg
    27 
    2827
    2928=== Usage
     
    4039  expressions are recognized:
    4140 
    42                == Expression ==                   == Default ==
    43    (chicken-setup "<path to chicken-setup>")    chicken-setup
    44    (chicken-setup-args "<args>"                 a procedure which returns "-d -destdir (repo-test-dir)" if chicken
    45                                                 version is greater than 2.5 or "-d" otherwise.
    46    (env-vars "<environment variables settings>" CHICKEN_REPOSITORY=(repo-test-dir) CHICKEN_INCLUDE_PATH=(repo-test-dir)
    47    (repo-test-dir "<path to repo-test-dir>")    `pwd`/salmonella-repo
    48    (skip-eggs (list "egg1" "egg2" ...))         '()
    49    (verbose <bool>)                             #f
    50    (logfile "filename")                         salmonella.log
    51    (eggs (lambda () ...))                       a procedure which fetches eggs list from call/cc.org
    52    (system-deps "filename")                     #f
    53    (pkg-manager "system pkg manager & args")    #f
    54    (resume <bool>)                              #f
    55    (dont-ask <bool>)                            #f
    56    (progress-file "filename")                   salmonella.progress
    57    (html-output "dirname")                      salmonella-report.  If #f, no HTML output
    58    (css-file "filename")                        #f
     41   == Expression ==                               == Default ==
     42   (chicken-install "<path to chicken-install>")  chicken-install
     43   (chicken-install-args "<args>"                 a procedure which returns "-prefix (repo-test-dir)"
     44   (env-vars "<environment variables settings>"   CHICKEN_REPOSITORY=(repo-test-dir) CHICKEN_INCLUDE_PATH=(repo-test-dir)
     45   (repo-test-dir "<path to repo-test-dir>")      `pwd`/salmonella-repo
     46   (skip-eggs (list "egg1" "egg2" ...))           '()
     47   (verbose <bool>)                               #f
     48   (logfile "filename")                           salmonella.log
     49   (eggs (lambda () ...))                         a procedure which fetches eggs list
     50   (system-deps "filename")                       #f
     51   (pkg-manager "system pkg manager & args")      #f
     52   (resume <bool>)                                #f
     53   (dont-ask <bool>)                              #f
     54   (progress-file "filename")                     salmonella.progress
     55   (html-output "dirname")                        salmonella-report.  If #f, no HTML output
     56   (css-file "filename")                          #f
    5957
    6058  Example:
    6159 
    62    salmonella '(chicken-setup "/usr/local/chicken/bin/chicken-setup") (verbose #t)'
     60   salmonella '(chicken-install "/usr/local/chicken/bin/chicken-install") (verbose #t)'
    6361
    6462==== Options
    6563
    66 * {{chicken-setup}}: full path to the {{chicken-setup}} program. Default is {{"chicken-setup"}}.
     64* {{chicken-install}}: full path to the {{chicken-install}} program. Default is {{"chicken-install"}}.
    6765
    68 * {{chicken-setup-args}}: a procedure which returns arguments to be passed to {{chicken-setup}}.  Default is {{-d -destdir (repo-test-dir)}} if chicken version is greater than 2.5 or {{-d}} otherwise.
     66* {{chicken-install-args}}: a procedure which returns arguments to be
     67  passed to {{chicken-install}}.  Default is {{-prefix (repo-test-dir)}}.
    6968
    70 * {{env-vars}}: environment variable settings to be applied when chicken-setup is invoked.  Default is {{CHICKEN_REPOSITORY=(repo-test-dir) CHICKEN_INCLUDE_PATH=(repo-test-dir)}} (where {{(repo-test-dir)}} is a salmonella parameter).
     69* {{env-vars}}: environment variable settings to be applied when
     70  chicken-install is invoked.  Default is
     71  {{CHICKEN_REPOSITORY=(repo-test-dir)
     72  CHICKEN_INCLUDE_PATH=(repo-test-dir)}} (where {{(repo-test-dir)}} is
     73  a salmonella parameter).
    7174
    72 * {{repo-test-dir}}: full path to the the directory salmonella will use for testing the installation og eggs. Default is {{"salmonella-repo"}}.
     75* {{repo-test-dir}}: full path to the the directory salmonella will
     76  use for testing the installation og eggs. Default is
     77  {{"salmonella-repo"}}.
    7378
    7479* {{skip-eggs}}: list of eggs to skip from testing. Default is {{'()}}.
     
    8590   (egg2 package1 package2 ... packagen)
    8691
    87 This option should be used with the {{pkg-manager}} option.  Default is {{#f}}.
     92This option should be used with the {{pkg-manager}} option.  Default
     93is {{#f}}.
    8894
    89 * {{pkg-manager}}: path to the system package manager and its arguments.  It's used with the {{system-deps}} option to install system packages which some eggs depend on. Default is {{#f}}.
     95* {{pkg-manager}}: path to the system package manager and its
     96  arguments.  It's used with the {{system-deps}} option to install
     97  system packages which some eggs depend on. Default is {{#f}}.
    9098
    91 * {{logfile}}: path to the file where logging information is stored. Default is {{"salmonella.log"}}.
     99* {{logfile}}: path to the file where logging information is
     100  stored. Default is {{"salmonella.log"}}.
    92101
    93 * {{resume}}: tells salmonella that it should continue from the point it last stopped.  Salmonella uses information from the file indicated by the {{progress-file}}. Default is {{#f}}.
     102* {{resume}}: tells salmonella that it should continue from the point
     103  it last stopped.  Salmonella uses information from the file
     104  indicated by the {{progress-file}}. Default is {{#f}}.
    94105
    95 * {{progress-file}}: keeps track of which eggs were already tested (useful for resumming -- see the {{resume}} option). Default is {{"salmonella.progress"}}.
     106* {{progress-file}}: keeps track of which eggs were already tested
     107  (useful for resuming -- see the {{resume}} option). Default is
     108  {{"salmonella.progress"}}.
    96109
    97 * {{html-output}}: path to the directory where the HTML output should be saved. If the directory exists, it will be deleted. If {{#f}}, no HTML output is generated.  Default is {{"salmonella-report"}}.
     110* {{html-output}}: path to the directory where the HTML output should
     111  be saved. If the directory exists, it will be deleted. If {{#f}}, no
     112  HTML output is generated.  Default is {{"salmonella-report"}}.
    98113
    99 * {{css-file}}: CSS file to be used in the HTML-formated output.  Default is {{#f}} -- a built-in CSS code is used.
     114* {{css-file}}: CSS file to be used in the HTML-formated output.
     115  Default is {{#f}} -- a built-in CSS code is used.
Note: See TracChangeset for help on using the changeset viewer.