[cmucl-cvs] [git] CMU Common Lisp branch master updated. snapshot-2011-10-18-ge9c497d

[Alex Goncharov]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMU Common Lisp".

The branch, master has been updated
       via  e9c497d7156a43a4acb77c26e392fb47f9c47552 (commit)
      from  987c3f200c854ede9196132e517756c5d4421239 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit e9c497d7156a43a4acb77c26e392fb47f9c47552
Author: Alex Goncharov <alex-goncharov at comcast.net>
Date:   Thu Oct 13 00:11:25 2011 -0400

    compiler/main.lisp: Improve the doc strings for compile-file and compile-file-pathname.
    Unify the use of the FASL and NIL words across all documentation strings in this file.

diff --git a/compiler/main.lisp b/compiler/main.lisp
index a4bbefd..9e16830 100644
--- a/compiler/main.lisp
+++ b/compiler/main.lisp
@@ -1801,12 +1801,19 @@
 			     *byte-compile-default*)
 		            ((:xref *record-xref-info*)
 			     *record-xref-info*))
-  "Compiles Source, producing a corresponding .FASL file.  Source may be a list
+  "Compiles Source, producing a corresponding FASL file.  Source may be a list
   of files, in which case the files are compiled as a unit, producing a single
-  .FASL file.  The output file names are defaulted from the first (or only)
-  input file name.  Other options available via keywords:
+  FASL file.  The output file names are defaulted from the first (or only)
+  input file name.  (The use of a list for Source is a CMUCL extension, not
+  specified in CLHS.)
+
+  These keywords are supported:
+
   :Output-File
-     The name of the fasl to output, NIL for none, T for the default.
+     The name of the FASL to output, NIL for none, T for the default.  (Note the
+     difference between the treatment of NIL :Output-File here and in COMPILE-FILE-PATHNAME.)
+     The returned pathname of the output file may differ from the pathname of the
+     :Output-File parameter, e.g. when the latter is a designator for a directory.
   :Load
      Load the compiled file; T here requires :Output-File to be non-NIL, as well.
      The default for :Load is NIL.
@@ -1848,7 +1855,7 @@
      The external format to use when opening the source file.
   :Decoding-Error
      How to handle decoding errors in the external format when reading the
-     source file.  Default (T) is to signal an error.  Nil means silently
+     source file.  Default (T) is to signal an error.  NIL means silently
      continue, replacing the invalid sequence with a suitable replacment
      character."
   (let* ((fasl-file nil)
@@ -2001,7 +2008,7 @@
   be compiled.  IF NAME names a macro, then the compiled expression
   replaces the existing macro-function.  If NAME names a function, the
   compiled expression is placed in the function cell of NAME.  If NAME
-  is Nil, the compiled code object is returned."
+  is NIL, the compiled code object is returned."
   (with-compilation-unit ()
     (with-ir1-namespace
       (let* ((*backend* *native-backend*)
@@ -2128,8 +2135,10 @@
 			      (byte-compile *byte-compile-default*)
 			      (output-file t output-file-supplied-p)
 			      &allow-other-keys)
-  "Return a pathname describing what file COMPILE-FILE would write to given
-  these arguments."
+  "Return a pathname describing what file COMPILE-FILE would write to given these arguments.
+  The returned pathname of the output file may differ from the pathname of the :Output-File
+  parameter, e.g. when the latter is a designator for a directory. The CMUCL caveat: NIL is
+  accepted for :Output-File there but not here, which is probably not in line with CLHS."
   (declare (type (or string pathname stream) input-file)
 	   (type (or string pathname stream (member t)) output-file)
 	   (values (or null pathname)))

-----------------------------------------------------------------------

Summary of changes:
 compiler/main.lisp |   25 +++++++++++++++++--------
 1 files changed, 17 insertions(+), 8 deletions(-)


hooks/post-receive
-- 
CMU Common Lisp