Changeset 31433 in project


Ignore:
Timestamp:
09/15/14 20:49:47 (7 years ago)
Author:
sjamaan
Message:

Update henrietta-cache manual

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/henrietta-cache

    r29973 r31433  
    2727Henrietta-cache can be invoked as follows:
    2828
    29   henrietta-cache [-h] [-c|-cache-dir CACHEDIR] [-e|-egg-list EGGLIST] [-i|-init-file INITFILE]
     29  henrietta-cache [-h] [-r|-chicken-release RELEASE] [-c|-cache-dir CACHEDIR] [-e|-egg-list EGGLIST] [-i|-init-file INITFILE]
    3030
    3131The {{CACHEDIR}} points at the directory in which to place the cached
    3232files.  It defaults to "{{cache}}".  It will automatically create a
    33 subdirectory for each egg in the list and create a subdirectory called
    34 "{{tags}}" underneath those, in which it creates one directory for
    35 each release.  This structure is used because it is expected by
    36 henrietta, and may change in the future.
     33subdirectory for each egg in the list, under which it creates one
     34subdirectory for each egg release.  This structure is used because it
     35is expected by henrietta, and may change in the future.
    3736
    3837The {{EGGLIST}} points to a file containing the list of eggs to fetch.
    3938It may be either a filename or an HTTP(S) URI.
     39
     40The {{RELEASE}} indicates a major CHICKEN release.  This will only be
     41used when performing requests to get the correct URI.
    4042
    4143The {{INITFILE}} is a file which will be loaded before starting the download process. This can be used to set handlers on the hooks, as documented below.
     
    5254This is a hook you can register to run some code whenever a full release of an egg has been successfully downloaded.
    5355
    54 {{SUCCESS-HOOK}} is a procedure of two arguments: the egg name and the release version (both strings).
     56{{SUCCESS-HOOK}} is a procedure of three arguments: the major CHICKEN release (an integer), the egg name and the release version (both strings).
    5557
    5658<parameter>(download-release-error-hook [ERROR-HOOK])</parameter>
     
    5860This is a hook you can register to run some code whenever a full release of an egg has failed to download.
    5961
    60 {{ERROR-HOOK}} is a procedure of three arguments: the egg name, the release version and the error message on the exception that was thrown when the failure happened (all three are strings).
     62{{ERROR-HOOK}} is a procedure of four arguments: the major CHICKEN release (an integer), the egg name, the release version and the error message on the exception that was thrown when the failure happened (the latter three are all strings).
    6163
    6264<parameter>(download-release-info-file-error-hook [ERROR-HOOK])</parameter>
     
    6466This is a hook you can register to run some code whenever the download of the release-info file of an egg failed.
    6567
    66 {{ERROR-HOOK}} is a procedure of three arguments: the egg name, the URI-string of the release-info file's location and the error message on the exception that was thrown when the failure happend (all three are strings).
     68{{ERROR-HOOK}} is a procedure of four arguments: the major CHICKEN release (an integer), the egg name, the URI-string of the release-info file's location and the error message on the exception that was thrown when the failure happend (the latter three are all strings).
    6769
    6870
    6971=== Changelog
    7072
     73* 1.0 - Add support for major CHICKEN release under the cache dir.  Hooks are incompatible now because they get an extra leading argument!  The "tags" directory is no longer inserted in between the egg and version name.
    7174* 0.4.1 - Skip over {{pax_global_header}}.  Thanks to Carl Douglas and [[/users/mario-domenech-goulart|Mario Goulart]] for reporting this.
    7275* 0.4 - Use {{tar}} instead of {{pax}}, as it won't accept extended GNU tar files (and ustar archives have crippling limitations on maximum file length). Thanks to [[/users/alaric-blagrave-snellpym|Alaric Snell-Pym]] for pointing out this problem. Make downloads more robust against failure by downloading/extracting to a tempdir and moving only when everything is alright.
     
    8992=== License
    9093
    91   Copyright (c) 2011-2013, Peter Bex
     94  Copyright (c) 2011-2014, Peter Bex
    9295  All rights reserved.
    9396 
Note: See TracChangeset for help on using the changeset viewer.