From bbfaa46f8dcb532461b3f578491596dae1d78ed3 Mon Sep 17 00:00:00 2001 From: Matt Birkholz Date: Sun, 2 Jul 2017 15:07:23 -0700 Subject: [PATCH] plugin READMEs: Update. Punt mention of nonexistent microcode modules and conflicting bindings. Punt import-blowfish and import-gdbm2. Fix stale references to GDBM2. --- src/blowfish/README | 11 ++--------- src/edwin/README | 9 +++++++++ src/gdbm/README | 15 ++++----------- src/imail/README | 8 ++++++++ src/mcrypt/README | 5 ++--- src/md5/README | 5 ++--- src/mhash/README | 5 ++--- src/x11-screen/README | 5 ++--- src/x11/README | 3 +-- 9 files changed, 32 insertions(+), 34 deletions(-) diff --git a/src/blowfish/README b/src/blowfish/README index 60186b802..dee08ef31 100644 --- a/src/blowfish/README +++ b/src/blowfish/README @@ -1,8 +1,7 @@ The Blowfish option. -This plugin creates a (blowfish) package, a drop-in replacement for -the microcode module based (runtime blowfish) package. It is built in -the customary GNU way: +This plugin creates a (blowfish) package. It is built in the +customary GNU way: ./configure [--with-openssl=directory]... make all check install @@ -10,12 +9,6 @@ the customary GNU way: To use: (load-option 'blowfish) - (import-blowfish) - -Import-blowfish will modify the REPL's current environment by adding -bindings linked to the plugin's exports. They are not exported to the -global environment because they would conflict with the exports from -(runtime blowfish). To import into a CREF package set, add this to your .pkg file: diff --git a/src/edwin/README b/src/edwin/README index 804f52a80..52c3c027e 100644 --- a/src/edwin/README +++ b/src/edwin/README @@ -1,3 +1,12 @@ +The EDWIN option. + +This option extends Scheme with a source code (text) editor. After +loading this option, a global procedure named `edit' should be +available. + +For more information see the accompanying user / reference manual. + + Notes on the Edwin sources: If you want to add a new file to the source tree, you need to diff --git a/src/gdbm/README b/src/gdbm/README index 89c7aa238..91673b3d8 100644 --- a/src/gdbm/README +++ b/src/gdbm/README @@ -1,21 +1,14 @@ -The GDBM2 option. +The GDBM option. -This plugin creates a (gdbm) package, a drop-in replacement for the -microcode module based (runtime gdbm) package. It is built in the -customary GNU way: +This plugin creates a (gdbm) package. It is built in the customary +GNU way: ./configure ... make all check install To use: - (load-option 'gdbm2) - (import-gdbm2) - -Import-gdbm2 will modify the REPL's current environment by adding -bindings linked to the plugin's exports. They are not exported to the -global environment because they would conflict with the exports from -(runtime gdbm). + (load-option 'gdbm) To import into a CREF package set, add this to your .pkg file: diff --git a/src/imail/README b/src/imail/README index 804f52a80..d87b282f1 100644 --- a/src/imail/README +++ b/src/imail/README @@ -1,3 +1,11 @@ +The IMAIL option. + +This option extends Edwin with an IMAP email reader. After loading +this option, an Edwin command named `imail' should be available. + +For more information see the accompanying user / reference manual. + + Notes on the Edwin sources: If you want to add a new file to the source tree, you need to diff --git a/src/mcrypt/README b/src/mcrypt/README index 99e3112f7..c08876358 100644 --- a/src/mcrypt/README +++ b/src/mcrypt/README @@ -1,8 +1,7 @@ The Mcrypt option. -This plugin creates an (mcrypt) package, a drop-in replacement for the -microcode module based mcrypt-* procedures in the (runtime crypto) -package. It is built in the customary GNU way: +This plugin creates an (mcrypt) package. It is built in the customary +GNU way: ./configure ... make all check install diff --git a/src/md5/README b/src/md5/README index eb5da29a5..b1635a40a 100644 --- a/src/md5/README +++ b/src/md5/README @@ -1,8 +1,7 @@ The MD5 option. -This plugin creates an (md5) package, a drop-in replacement for the -microcode module based md5-* procedures in the (runtime crypto) -package. It is built in the customary GNU way: +This plugin creates an (md5) package. It is built in the customary +GNU way: ./configure [--with-openssl=directory]... make all check install diff --git a/src/mhash/README b/src/mhash/README index ce97f35b8..729f89bb6 100644 --- a/src/mhash/README +++ b/src/mhash/README @@ -1,8 +1,7 @@ The Mhash option. -This plugin creates an (mhash) package, a drop-in replacement for the -microcode module based mhash-* procedures in the (runtime crypto) -package. It is built in the customary GNU way: +This plugin creates an (mhash) package. It is built in the customary +GNU way: ./configure ... make all check install diff --git a/src/x11-screen/README b/src/x11-screen/README index 6fe2f9959..b94de5b65 100644 --- a/src/x11-screen/README +++ b/src/x11-screen/README @@ -1,8 +1,7 @@ The X11-SCREEN option. This plugin creates an (edwin screen x11-screen) package that -registers an Edwin display type named X11, an exact replacement for -the microcode module based X screen type. The plugin is built in the +registers an Edwin display type named X11. The plugin is built in the customary GNU way: ./configure ... @@ -15,4 +14,4 @@ To load: Loading this plugin re-assigns bindings in (edwin) and (edwin x-commands); any existing Edwin screens will stop working. You must load this option before starting Edwin. If the DISPLAY environment -variable is set, Edwin will create X11 screens. +variable is set, Edwin will then create X11 screens. diff --git a/src/x11/README b/src/x11/README index fda45ea36..57b69f1f8 100644 --- a/src/x11/README +++ b/src/x11/README @@ -1,8 +1,7 @@ The X11 option. This plugin creates an (x11) package that registers a graphics device -type named X11, an exact replacement for the microcode module based X -graphics device type. The plugin is built in the customary GNU way: +type named X11. The plugin is built in the customary GNU way: ./configure ... make all check install -- 2.25.1