Commit ae88f40f authored by Raymond Toy's avatar Raymond Toy

Format docstrings for COMPILE-FILE and COMPILE-FILE-PATHNAME so

DESCRIBE prints them neatly.
parent e9c497d7
...@@ -1810,13 +1810,14 @@ ...@@ -1810,13 +1810,14 @@
These keywords are supported: These keywords are supported:
:Output-File :Output-File
The name of the FASL to output, NIL for none, T for the default. (Note the The name of the FASL to output, NIL for none, T for the default.
difference between the treatment of NIL :Output-File here and in COMPILE-FILE-PATHNAME.) (Note the difference between the treatment of NIL :Output-File
The returned pathname of the output file may differ from the pathname of the here and in COMPILE-FILE-PATHNAME.) The returned pathname of the
:Output-File parameter, e.g. when the latter is a designator for a directory. 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
Load the compiled file; T here requires :Output-File to be non-NIL, as well. Load the compiled file; T here requires :Output-File to be
The default for :Load is NIL. non-NIL, as well. The default for :Load is NIL.
:Error-File :Error-File
The name of the error listing file, NIL for none (the default), T for .err. The name of the error listing file, NIL for none (the default), T for .err.
:Trace-File :Trace-File
...@@ -2135,10 +2136,12 @@ ...@@ -2135,10 +2136,12 @@
(byte-compile *byte-compile-default*) (byte-compile *byte-compile-default*)
(output-file t output-file-supplied-p) (output-file t output-file-supplied-p)
&allow-other-keys) &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
The returned pathname of the output file may differ from the pathname of the :Output-File given these arguments. The returned pathname of the output file may
parameter, e.g. when the latter is a designator for a directory. The CMUCL caveat: NIL is differ from the pathname of the :Output-File parameter, e.g. when
accepted for :Output-File there but not here, which is probably not in line with CLHS." 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) (declare (type (or string pathname stream) input-file)
(type (or string pathname stream (member t)) output-file) (type (or string pathname stream (member t)) output-file)
(values (or null pathname))) (values (or null pathname)))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment