Changeset 21040 in project


Ignore:
Timestamp:
10/26/10 00:16:16 (11 years ago)
Author:
Jim Ursetto
Message:

gazette #9: more awkward fumbles and whispered apologies

File:
1 edited

Legend:

Unmodified
Added
Removed
  • gazette/src/issues/9.wiki

    r21023 r21040  
    11((title . "Issue 9")
    22 (authors "Jim Ursetto")
    3  (date . 1287993883))
     3 (date . 1288033883))
    44
    55== 0. Introduction
     
    1212First off, this week's egg news.
    1313
    14 * http-session: fix a bug in session ID generation for long-lived
    15 processes, due to a timer overflow in {{current-milliseconds}};
    16 * estraier: performance improvement and regex dependency dropped;
    17 * wiki-parse: deleted, as it was unused and had diverged too far
    18 from upstream to be maintained;
    19 * chickadee: added a wrapper program which simplifies installing
    20 and running a server;
    21 * shell: a thin wrapper around a turtle;
    22 * salmonella: now checks that eggs are documented and executes egg tests; also something you can find on a turtle;
    23 * a proper exit code was added to tests/run.scm in many eggs to take advantage of the new salmonella egg testing;
    24 * explicit dependencies on the new {{regex}} egg were added to yet more eggs
    25 for compatibility with 4.6.2 and later.
    26 
    27 And now a public service announcement.  Egg authors, egg authors;
    28 now hear this.  When your egg installs both library files via
     14* [[http://wiki.call-cc.org/egg/http-session|http-session]]: fix a bug in session ID generation for long-lived processes, due to a timer overflow in {{current-milliseconds}};
     15* [[http://wiki.call-cc.org/egg/estraier-client|estraier]]: performance improvement and regex dependency dropped;
     16* [[http://wiki.call-cc.org/egg/wiki-parse|wiki-parse]]: deleted, as it was unused and had diverged too far from upstream to be maintained;
     17* [[http://wiki.call-cc.org/egg/chickadee|chickadee]]: added a wrapper program which simplifies installing and running a server;
     18* [[http://wiki.call-cc.org/egg/shell|shell]]: a thin wrapper around a turtle;
     19* [[http://wiki.call-cc.org/egg/salmonella|salmonella]]: now checks that eggs are documented and executes egg tests; also something you can find on a turtle
     20
     21To take advantage of the new salmonella egg testing, a proper exit
     22code was added to {{tests/run.scm}} in many eggs, reflecting
     23whether a test failure occurred.
     24
     25Additionally, explicit dependencies on the new {{regex}} egg were
     26added to yet more eggs for compatibility with 4.6.2 and later.
     27
     28And now a public service announcement.  Egg authors, now hear this.
     29When your egg installs both library files via
    2930{{install-extension}} and also an executable via {{install-program}},
    3031you need to use different IDs for each.  By convention, the library
     
    3334{{chicken-doc-cmd}}.  This prevents the uninstaller from losing track
    3435of files.  Specifically, the .setup-info files created by {{chicken-install}}
    35 to track extension metadata will be clobbered if your IDs are identical.
     36to track extension metadata will clobber each other if the IDs are identical.
    3637
    3738== 2. Yolklore
     
    9394Alan Post asked how to [[http://www.mail-archive.com/chicken-users@nongnu.org/msg12313.html|access mmapped memory as a string]] and, having received a couple ideas from your illustrious developers, graciously wrote them up [[http://wiki.call-cc.org/manual/Unit%20posix#memory-mapped-io-example|on the wiki]].
    9495
    95 Finally, [[http://wiki.call-cc.org/users/mario-goulart|Mario Goulart]]
    96 let us know that the {{salmonella}} egg tester [[http://www.mail-archive.com/chicken-users@nongnu.org/msg12334.html|has been updated]] to check if eggs are documented and to run egg tests.  Authors are urged to update their test scripts for compliance with salmonella; see [[http://tests.call-cc.org/2010/10/24/salmonella-report/|Mario's mail]] for details.
     96[[http://wiki.call-cc.org/users/felix-winkelmann|Felix]] informed us that a [[http://wiki.call-cc.org/wish-list|"wish-list"]] page has been added to the wiki, as a place where users can describe their most earnest desires and fever-dreams.  About Chicken.
     97
     98Finally, [[http://wiki.call-cc.org/users/mario-domenech-goulart|Mario Goulart]]
     99let us know that the {{salmonella}} egg tester [[http://www.mail-archive.com/chicken-users@nongnu.org/msg12334.html|has been updated]] to check if eggs are documented and to run egg tests.  Authors are urged to update their test scripts for salmonella compliance.
    97100
    98101== 4. Omelette Recipes
     
    104107Chicken.  Its primary goal is to provide access to documentation from the command-line and REPL.
    105108
    106 Now, Chicken doesn't embed introspective documentation in source code
    107 (as in docstrings) nor are docs installed alongside the eggs.
     109Now, Chicken doesn't provide introspection in the form of docstrings,
     110nor are docs installed alongside the eggs.
    108111Instead, the core and eggs are thoroughly documented on the wiki so
    109112that everyone can contribute.  So, chicken-doc's approach is to
     
    131134The repository goes inside your Chicken install directory and you may
    132135need sudo to write to it.  Alternatively, you could put the repository
    133 anywhere you want by setting the environment variable
    134 CHICKEN_DOC_REPOSITORY.
     136anywhere you want like this:
     137
     138 export CHICKEN_DOC_REPOSITORY=/path/to/my/cdoc/repo/dir
    135139
    136140==== The command-line
     
    236240* easy installation and use offline
    237241* documentation server for your own projects
    238 * preview wiki doc changes locally
     242* a local preview of wiki doc changes
     243* a sort of lisp-machine chic
    239244
    240245You can use the primary chickadee server at
     
    242247setting up a chicken-doc repository:
    243248
    244  $ chicken-install chickadee
     249 $ chicken-install -s chickadee
    245250 $ chickadee serve               # start on http://localhost:8080
    246251 $ chickadee serve --port 8081   # start on http://localhost:8081
     
    252257==== chicken-doc-admin
    253258
    254 So this is the way to use chicken-doc as nature intended: check out
    255 a copy of the wiki and then process it with chicken-doc-admin.
    256 (Again, you might need to use sudo.)
    257 
    258  $ chicken-install chicken-doc-admin
    259  $ chicken-doc-admin -i
     259So this is the way to use chicken-doc as nature intended: checkout the
     260wiki and then process it with chicken-doc-admin.  First, grab a copy
     261of the wiki and initialize an empty chicken-doc repository:
     262
     263 $ chicken-install -s chicken-doc-admin
     264 $ sudo chicken-doc-admin -i
    260265 $ svn co --username anonymous --password "" \
    261266     http://code.call-cc.org/svn/chicken-eggs/wiki
    262267
    263  $ chicken-doc-admin -m wiki/man/4
     268Then add the Chicken 4 man and egg pages to your database:
     269
     270 $ sudo chicken-doc-admin -m wiki/man/4
    264271 49 man pages processed, 49 updated
    265  $ chicken-doc-admin -e wiki/eggref/4
     272 $ sudo chicken-doc-admin -e wiki/eggref/4
    266273 347 eggs processed, 347 updated
    267274
     
    270277
    271278 $ svn up wiki/eggref/4
    272  $ chicken-doc-admin -e wiki/eggref/4
     279 $ sudo chicken-doc-admin -e wiki/eggref/4
    273280 347 eggs processed, 28 updated
    274281
     
    278285
    279286 $ emacs wiki/eggref/4/atom
    280  $ chicken-doc-admin -e wiki/eggref/4
     287 $ sudo chicken-doc-admin -e wiki/eggref/4
    281288 347 eggs processed, 1 updated
    282289
Note: See TracChangeset for help on using the changeset viewer.