Changeset 31432 in project


Ignore:
Timestamp:
09/15/14 20:43:11 (5 years ago)
Author:
sjamaan
Message:

Update pseudo-meta-egg-info manual

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/pseudo-meta-egg-info

    r29799 r31432  
    2424for an SVN repository.
    2525
    26 It assumes the svn repository location contains subdirectories
    27 matching the names of eggs and those subdirectories contain a
    28 directory called "tags" with underneath it a directory for each
    29 revision, with the revision number as its name:
     26It assumes the svn repository location contains a toplevel directory
     27named after the major CHICKEN release, with subdirectories matching
     28the names of eggs.  Those egg directories contain a "tags" directory
     29for each revision, with the revision number as its name:
    3030
    31  /MY-EGG
    32    /tags
    33      /1.0
    34      /1.1
    35  /ANOTHER-EGG
    36    /tags
    37      /0.1
    38      /0.2
    39      /1.0
     31 /4
     32   /MY-EGG
     33     /tags
     34       /1.0
     35       /1.1
     36   /ANOTHER-EGG
     37     /tags
     38       /0.1
     39       /0.2
     40       /1.0
     41 /5
     42   /MY-EGG
     43     /tags
     44       /2.0
     45       /2.1
     46   /SOME-NEWER-EGG
     47     /tags
     48       /0.1
    4049
    4150You can use it like this (assuming you have [[spiffy-uri-match]]
     
    5665</enscript>
    5766
    58 This makes the release-info for egg MY-EGG available under
    59 {{http://localhost:8080/release-info?egg=MY-EGG}}
     67This makes the release-info for the CHICKEN 4 version of egg MY-EGG, available under
     68{{http://localhost:8080/release-info?egg=MY-EGG;release=4}}
    6069
    61 and the files-list for release 1.0 under
    62 {{http://localhost:8080/files-list?egg=MY-EGG;release=1.0}}
     70and the files-list for release 1.0 for the CHICKEN 5 version of MY-EGG under
     71{{http://localhost:8080/files-list?egg=MY-EGG;release=1.0;release=5}}
    6372
    6473<parameter>(egg-repo [URI-STRING])</parameter>
    6574
    66 {{URI-STRING}} is a string representing the repository URI holding
    67 the Subversion files.
     75{{URI-STRING}} is a string representing the repository URI holding the
     76Subversion files.  The placeholder {{{chicken-release}}} will get
     77replaced with the requested major CHICKEN release.  If none was
     78supplied, "4" is assumed.
    6879
    6980<procedure>(release-info CONTINUE)</procedure>
     
    7182This serves up the release-info file.  It assumes that
    7283{{current-request}} contains a request URI which contains a
    73 {{egg-name}} query parameter that indicates the name of the egg.
     84{{egg-name}} query parameter that indicates the name of the egg, and
     85possibly a {{release}} query parameter that indicates the major
     86release of CHICKEN for which to get the release info.
    7487
    7588<procedure>(files-list CONTINUE)</procedure>
     
    7790This serves up the file-list file.  It assumes that
    7891{{current-request}} contains a request URI which contains a
    79 {{egg-name}} query parameter that indicates the name of the egg and a
    80 {{release}} query parameter that indicates the release version of the
    81 egg.
     92{{chicken-release}} query parameter that indicates the major CHICKEN
     93version, an {{egg-name}} query parameter that indicates the name of
     94the egg, and an {{egg-release}} query parameter that indicates the
     95release version of the egg.
    8296
    8397
    8498=== Changelog
    8599
     100* 1.0 - Add support for multiple major CHICKEN releases.
    86101* 0.2 - Add extra validation so that empty egg names/release numbers are caught and a nice 400/404 is returned rather than triggering a hard assertion in libsvn and crashing the entire server.  Thanks, Subversion team! :S
    87102* 0.1.1 - Improved error messages.
Note: See TracChangeset for help on using the changeset viewer.