From 2414d39e1e3d0824894bd129116755a6d71dedf4 Mon Sep 17 00:00:00 2001 From: Francois-Rene Rideau Date: Tue, 5 May 2015 23:16:52 -0400 Subject: [PATCH] Trivial documentation update --- doc/index.html | 56 +++++++++++++++++++++++++++----------------------- uiop/README.md | 30 ++++++++++++++++++--------- 2 files changed, 50 insertions(+), 36 deletions(-) diff --git a/doc/index.html b/doc/index.html index a430cc9b..f09c3e17 100644 --- a/doc/index.html +++ b/doc/index.html @@ -84,7 +84,9 @@ call other programs and parse their output, compile Lisp code, muffle conditions, or configure Lisp software. See its - README.md. + README.md for an overview, + and the documentation as extracted from its docstrings by + HEΛP.

uiop is distributed as part of the ASDF, its source code is transcluded in the single-file asdf.lisp being distributed @@ -120,14 +122,15 @@ quick-build (also reimplemented as the ASDF extension asdf-package-system; similar to faslpath below). + >asdf-package-system, now part of ASDF 3; + similar to faslpath below).

  • François-René Rideau's XCVB (building object and image files deterministically and in parallel, but not actively maintained since 2012; - thanks to its new build model, ASDF 3 could conceivably be modified - to support these features). + a hypothetical ASDF 4 could conceivably be evolved to support these features + thanks to the groundwork laid by ASDF 3).
  • Drew McDermott's YTools @@ -187,16 +190,16 @@ mcl xcl Proprietary allegro - lispworks mocl - cormanlisp genera scl + lispworks + cormanlisp genera mocl scl

    To deal with an implementation that doesn't yet provide ASDF 3, - we provide a script that can install ASDF 3 - where your implementation goes looking for it + we provide a script + that can install ASDF 3 where your implementation goes looking for it when you (require "asdf") .

    - Alternatively, if the implementation provides ASDF 2 + Alternatively, though we don't recommend it, if the implementation provides ASDF 2 (as do lispworks mocl xcl or older versions of some implementations) or an overly old version of ASDF 3, you can download, install and configure a more recent ASDF 3, @@ -329,7 +332,7 @@ XCL (Peter Graves) to compute the actual dependencies in a big ASDF system.

  • poiu, - to compile a system in parallel.
  • + to compile a system in parallel on a multiprocessor machine.
  • asdf-system-connections, lets you specify systems that are automatically loaded when @@ -337,19 +340,10 @@ XCL (Peter Graves)
  • asdf-flv, to bind file-local variables around the compilation of some files.
  • -
  • asdf-package-system, - to compile Lisp source files with one package per file - that also determines dependencies, in the style of - quick-build or - faslpath - (this functionality is built into recent versions of ASDF 3.1 and later, - but this package exists for backward compatibility with earlier versions of ASDF 3; - search the manual for package-inferred-system).

    Former extensions, now superseded, include:

    Contributing

    @@ -497,9 +501,9 @@ XCL (Peter Graves) hacker button ALU button Common-Lisp.net button -

    +

    ASDF has an MIT style license

    -
    Last updated 2015-03-28
    +
    Last updated 2015-05-05
    diff --git a/uiop/README.md b/uiop/README.md index b3a23b1e..1244cbfd 100644 --- a/uiop/README.md +++ b/uiop/README.md @@ -1,5 +1,5 @@ -UIOP the Utilities for Implementation- and OS- Portability -========================================================== +UIOP, the Utilities for Implementation- and OS- Portability +=========================================================== UIOP is the portability layer of ASDF. It provides utilities that abstract over discrepancies between implementations, @@ -9,9 +9,11 @@ what programmers actually need, to write portable Common Lisp programs. It is organized by topic in many files, each of which defines its own package according to its topic: e.g `pathname.lisp` will define package `UIOP/PATHNAME` and contain utilities related to the handling of pathname objects. -All exported symbols are reexported in a convenience package `UIOP`. +All exported symbols are reexported in a convenience package `UIOP`, +except for those from `UIOP/COMMON-LISP`. +We recommend package `UIOP` be used to access all the symbols. -The files that constitute UIOP are, in loading order: +The files that constitute UIOP are, in dependency loading order: * `package`: deals with packages and their symbols, most notably including `define-package`, a variant of `defpackage` capable of hot-upgrade, or @@ -21,7 +23,7 @@ The files that constitute UIOP are, in loading order: * `common-lisp`: lets you paper over various sub-standard implementations. Big offenders are Corman, GCL, Genera, MCL, all of them unmaintained. Supported without serious issues are: - ABCL, Allegro, CCL, CMUCL, CLISP, ECL, LispWorks, MKCL, SBCL, SCL, XCL. + ABCL, Allegro, CCL, CMUCL, CLASP, CLISP, ECL, LispWorks, MKCL, SBCL, SCL, XCL. * `utility`: provides macros and functions that do not involve I/O; it handles control-flow, (p)lists, characters, strings, functions, classes, conditions, @@ -63,8 +65,8 @@ The files that constitute UIOP are, in loading order: runs hooks around compilation (to e.g. control optimizations or syntax), identifies the pathname of the current file, combines FASLs, etc. -* `configuration`: helps you define portable configuration files, using best - practices to define and validate syntax, search standard paths, +* `configuration`: helps you portably locate and parse configuration files, + using best practices to define and validate syntax, search standard paths, let users specify pathnames or pathname patterns, etc. * `backward-driver`: provides backward-compatibility with earlier incarnations @@ -95,6 +97,10 @@ it only extracts information from the first package: http://quickdocs.org/uiop/api +See bug report: + + https://github.com/fukamachi/quickdocs/issues/24 + Using UIOP ---------- @@ -123,11 +129,15 @@ evolved from ASDF 2's internal utilities and portability layer. It has since fully superseded functionality from the following libraries: ASDF-UTILS (UIOP carries on the ASDF 2 utilities that this exported), CL-FAD (UIOP's pathname and filesystem functions are much more portable), -CL-LAUNCH (UIOP took its image and command-line argument handling from it), -EXTERNAL-PROGRAM, TRIVIAL-SHELL and XCVB-DRIVER (UIOP's run-program is better), -SLIME's swank-loader (UIOP has better compilation and API identification), +CL-LAUNCH (UIOP took its image and command-line argument handling), +EXTERNAL-PROGRAM, TRIVIAL-SHELL and XCVB-DRIVER (UIOP's run-program evolved +from XCVB-DRIVER's, and so did its condition muffling), +SLIME's swank-loader (UIOP has better compilation and ABI identification), TRIVIAL-BACKTRACE (UIOP/IMAGE has all of it and more), etc. UIOP also captures a large subset of the functionality from TRIVIAL-FEATURES, and a small subset of the functionality from ALEXANDRIA or FARE-UTILS. +We recommend you use UIOP instead of any of the above, where applicable, +since UIOP is more portable, more robust, more ubiquitous, better designed, +better documented, etc. -- 2.18.1