Changeset 37792 in project


Ignore:
Timestamp:
07/26/19 19:19:42 (5 months ago)
Author:
Mario Domenech Goulart
Message:

eggref/4/salmonella: documentation for version 3.0.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/salmonella

    r35398 r37792  
    6969
    7070  salmonella [ -h | --help ]
    71   salmonella <options> eggs
    72 
     71  salmonella --version
     72  salmonella [ [ <options> ] eggs ]
     73 
     74  When called without eggs in the command line, salmonella will try to
     75  find a .egg file in the current directory and process it (just like
     76  chicken-install).
     77 
    7378  <options>:
    7479  --log-file=<logfile>
    7580      The name for the log file to be generated by salmonella
    7681      (default=salmonella.log).
    77 
     82 
    7883  --chicken-installation-prefix=<prefix dir>
    7984      If you want to test eggs using a chicken installed on a certain directory,
     
    8186      `PREFIX' when installing CHICKEN). If omitted, salmonella uses CHICKEN
    8287      tools from the current runtime's installation prefix.
    83 
     88 
    8489  --chicken-install-args=<install args>
    8590      This option can be used customize chicken-install's arguments.  You can
    8691      use <repo> to indicate where you want the actual repository directory
    8792      to be replaced by salmonella.
    88 
     93 
    8994  --eggs-source-dir=<eggs dir>
    9095      By default, salmonella fetches eggs from the egg server.  If you have a
    9196      local copy of eggs code, you can use this option to point to the directory
    9297      where they are located.
    93 
     98 
    9499  --eggs-doc-dir=<doc dir>
    95100      By default, salmonella checks if documentation for eggs exist by accessing
     
    97102      eggs, you can use this option to point to the directory where they can be
    98103      found.
    99 
     104 
    100105  --keep-repo
    101106      For each egg that salmonella tests, it sets the egg installation repository
     
    105110      testing several eggs, at the cost of potentially making salmonella unable
    106111      to catch dependencies problems.
    107 
     112 
    108113  --skip-eggs=<comma-separated list of eggs to skip>
    109114      A comma-separated list of eggs to be skipped.
    110 
     115 
    111116  --repo-dir=<path to repo dir to be used>
    112117      Alternative location for the egg installation directory used by salmonella.
     
    114119      current directory.  This option can be useful when used with `--keep-repo'
    115120      to reuse egg installation repositories for several salmonella executions.
    116 
     121 
     122  --clear-chicken-home
     123      Remove Scheme files from <chicken-installation-prefix>/share/chicken.
     124      WARNING: use this option with care.  If you don't understand the
     125      consequences of this option, DON'T USE IT.  Extra care when you don't
     126      use --chicken-installation-prefix -- in this case --clear-chicken-home
     127      will remove Scheme files from your "host" CHICKEN installation.
     128      This option is only effective when --keep-repo is NOT used.
     129 
    117130  --verbosity=<number>
    118131      A number to indicate salmonella's verbosity level.  0 means practically
    119132      silent. 1 is mostly silent and 2 (default) prints some useful information
    120133      while salmonella is running.
    121 
     134 
    122135
    123136===== Some quick tips by example
     
    235248
    236249
     250
     251==== salmonella-log-inquirer
     252
     253{{salmonella-log-inquirer}} can be used to query salmonella log files.
     254Below you can see its help message and a usage example.
     255
     256  salmonella-log-inquirer [ -h | -help | --help ]
     257    Print this message.
     258 
     259  salmonella-log-inquirer --version
     260    Show version and exit.
     261 
     262  salmonella-log-inquirer --log-info <log file>
     263    Show information about the environment where salmonella was executed
     264    to generate the given <log-file> (e.g., environment variables, C
     265    compiler, CHICKEN version, salmonella command line etc.)
     266 
     267  salmonella-log-inquirer --statistics <log file>
     268    Show simple statistics on installation, tests and documentation from
     269    the log file .
     270 
     271  salmonella-log-inquirer --list-eggs <log file>
     272    List eggs covered in <log file>.
     273 
     274  salmonella-log-inquirer --action=<action> --egg=<egg> [ --part=<part> ] <log file>
     275    Query <action> and, optionally, <part> for <egg> in <log file>.
     276 
     277  <action>s:
     278  fetch
     279  install
     280  check-version
     281  test
     282  meta-data
     283 
     284  <part>s (the default part is "message"):
     285  message
     286  status
     287  duration
     288 
     289
     290Usage example:
     291
     292  $ salmonella-log-inquirer --action=fetch --egg=this salmonella.log
     293  '/home/chicken/salmonella/build/salmonella-run-publish/chicken/bin/chicken-install' -r -v -test this 2>&1
     294  this not cached
     295  resolving alias `kitten-technologies' to: http://chicken.kitten-technologies.co.uk/henrietta.cgi
     296  resolving alias `call-cc' to: http://code.call-cc.org/cgi-bin/henrietta.cgi
     297  trying server http://chicken.kitten-technologies.co.uk/henrietta.cgi ...
     298  downloading this: http://chicken.kitten-technologies.co.uk/henrietta.cgi
     299  connecting to host "chicken.kitten-technologies.co.uk", port 80 ...
     300  requesting "/henrietta.cgi?name=this&release=5&mode=default&tests=yes" ...
     301  reading response ...
     302  HTTP/1.1 200 OK
     303  Date: Thu, 25 Jul 2019 11:47:58 GMT
     304  Server: Apache/2.2.31 (Unix) DAV/2 PHP/5.5.36 mod_fastcgi/2.4.6
     305  Connection: close
     306  Transfer-Encoding: chunked
     307  Content-Type: text/plain
     308  reading chunks .
     309  reading files ...
     310    ./README.md
     311    ./this.egg
     312    ./this.release-info
     313    ./this.scm
     314  cp -r '/tmp/temp303b.18990'/* '/home/chicken/salmonella/build/salmonella-run-publish/salmonella-repo/repo/cache/this'
     315  this located at /home/chicken/salmonella/build/salmonella-run-publish/salmonella-repo/repo/cache/this
     316 
    237317
    238318==== Log file format
     
    576656=== Version history
    577657
     658==== Version 3.0.0
     659
     660* CHICKEN 5 support.  Now both CHICKEN 4 and CHICKEN 5 are supported. Most of the code is shared.  Where CHICKEN 4 and 5 are not compatible, {{cond-expand}} is used for version-specific implementations.
     661
     662* New command line tool: {{salmonella-log-inquirer}}.  This tool can be used to query salmonella log files.
     663
     664* More strict command line parser. Now invalid command line options are detected and reported as errors.
     665
     666* Exit non-zero in case of errors.  Salmonella now exits non-zero in case of any check failure.
     667
     668* Add {{--clear-chicken-home}} command line option for {{salmonella}} and {{salmonella-epidemy}}.  Don't use this option unless you know exactly what you are doing.  Check the documentation of this option before using it.
     669
     670* The {{--eggs-source-dir}} option has been removed.  It is still possible to use salmonella with a local directory containing egg sources by configuring {{chicken-install}} ({{-t local -l <eggs-source-dir>}} in CHICKEN 4 and by configuring the {{location}} form in {{PREFIX/share/chicken/setup.defaults}} in CHICKEN 5).
     671
     672* Replace --salmonella-prefix command line option by {{--salmonella-tools-dir}}.  {{salmonella-epidemy}} relies on both {{salmonella}} and {{salmonella-log-merger}}.  Since portably determining the directory of {{salmonella-epidemy}} is not trivial, and we don't want to rely on {{$PATH}} to call external tools, {{--salmonella-tools-dir}} has been created.  With this, {{--salmonella-prefix}} became useless.
     673
     674* Salmonella now copy {{csc}} and {{csi}} from {{<host-prefix>/bin}} to {{<tmp-dir>/bin}}.  With that, salmonella no longer adds <host-prefix>/bin to {{$PATH}}, which would cause salmonella to overlook eggs that rely on executables installed in {{<host-prefix>/bin}} but not declared as dependencies.
     675
     676* Many bugs fixed
     677
     678
    578679==== Version 2.7
    579680
Note: See TracChangeset for help on using the changeset viewer.