X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=contrib%2FSTANDARDS;h=80b0b58899d70e499e28a64687969bcbce85d1a0;hb=c27ee1dba86042cb431c298699c19ed3fcd70026;hp=f344dc555bd2412617a69d2ff0a95f504289ae84;hpb=10d2c05ea44ca0837091434fe2223c0c31687615;p=sbcl.git diff --git a/contrib/STANDARDS b/contrib/STANDARDS index f344dc5..80b0b58 100644 --- a/contrib/STANDARDS +++ b/contrib/STANDARDS @@ -1,6 +1,6 @@ -Proposed contrib standard, version $Revision$ +Proposed contrib standard, $Revision$ -The SBCL contrib mechanism is intended to provide a mechanism to +The SBCL contrib mechanism provides a mechanism to manage code which does not form part of SBCL itself, but which is sufficiently closely associated with it that it would not be sensible to run it as a completely separate project. For example, alternative @@ -21,10 +21,9 @@ to not install stale contrib code: a contrib that fails its test suite against a given version of SBCL will not be installed in that release. Note that despite leaving you the contrib maintainer with the -responsibility of maintenance, we don't _necessarily_ (although we -quite possibly would) offer you CVS access to the SBCL tree. This is -because we can't do that without letting you write to the rest of the -tree as well (at least as far as I know, at sourceforge). +responsibility of maintenance, it doesn't follow that we'd +_necessarily_ offer you CVS access to the SBCL tree: each application +is considered individually. We often do, though. ** Release cycle @@ -50,17 +49,18 @@ A contrib package must contain a Makefile. This is to have three targets all: # do whatever compilation is necessary test: # run the package tests -install: # copy all necessary files into $(INSTALL_DIR) +install: # copy all necessary files into $(BUILD_ROOT)$(INSTALL_DIR) If the contrib package involves more than one file, you are encouraged to use ASDF to build it and load it. A version of asdf is bundled as an SBCL contrib, which knows to look in $SBCL_HOME/systems/ for asd files - your install target should create an appropriate symlink there -to the installed location of the system file. Look in sb-bsd-sockets/Makefile -for an example of an asdf-using contrib +to the installed location of the system file. Look in +sb-bsd-sockets/Makefile for an example of an asdf-using contrib. -$(INSTALL_DIR) will have been created by the system before your -install target is called. You do not need to make it yourself. +$(BUILD_ROOT)$(INSTALL_DIR) will have been created by the system +before your install target is called. You do not need to make it +yourself. * Tests @@ -93,5 +93,5 @@ SBCL that provide clean documented APIs which reasonably can be preserved. If in doubt, seek consensus on the sbcl-devel list A contrib must load into its own Lisp package(s) instead of polluting -CL-USER or one of the system packages. The Lisp package name should +CL-USER or one of the system packages. The Lisp package names should begin with "SB-". Ask the sbcl-devel list for a suitable name.