The following terms are used in subsequent sections; it may be helpful to refer to these definitions.
-fasl
+ fasl
files are the object files produced
by The Lisp
+ The Lisp
kernel is a C program with a fair amount of
platform-specific assembly language code. Its basic job is to
@@ -1772,5 +1772,5 @@
files on different platforms; see
Table 3.1, âPlatform-specific filename conventionsâ. A heap
+ A heap
image is a file that can be quickly mapped into a
process's address space. Conceptually, it's not too different
@@ -1783,5 +1783,5 @@
standard full heap image files on different platforms; see
Table 3.1, âPlatform-specific filename conventionsâ. A bootstrapping image is a minimal
+ A bootstrapping image is a minimal
heap image used in the process of building Clozure CL itself. The
bootstrapping image contains just enough code to load the rest
@@ -1795,5 +1795,5 @@
as-yet-unsupported ones) has a uniquely named subdirectory of
-
+
TRACE {
-
+
CCL:*TRACE-LEVEL* [Variable]
Variable bound to the current nesting level during execution of before and after trace actions. The default printing actions use it to determine the amount of indentation.
-
+
CCL:*TRACE-MAX-INDENT* [Variable]
The default before and after print actions will not indent by more than the value of ccl:*trace-max-indent* regardless of the current trace level.
-
+
CCL:TRACE-FUNCTION compile-file. fasl files store the
@@ -1762,5 +1762,5 @@
see
Table 3.1, âPlatform-specific filename conventionsâ ccl/lisp-kernel/; each such
-
+
contains a Makefile and may contain some auxiliary files (linker
scripts, etc.) that are used to build the lisp kernel on a
@@ -2573,4 +2573,9 @@
+ keyword
global-value}* {spec |
@@ -3058,15 +3063,15 @@
spec &key {keyword value}* [Function]
- + CCL:*TRACE-BAR-FREQUENCY* [Variable]
@@ -3141,5 +3146,5 @@@@ -3221,5 +3226,5 @@
@@ -3260,5 +3265,5 @@
@@ -3432,5 +3437,5 @@
The value of this variable is used when :EXTERNAL-FORMAT is @@ -3458,5 +3463,5 @@
The value of this variable is used when an external-format @@ -3490,5 +3495,5 @@
domain---This is used to indicate where the external @@ -3524,5 +3529,5 @@
Despite the function's name, it doesn't necessarily create a @@ -3697,5 +3702,5 @@
@@ -3713,5 +3718,5 @@ @@ -3741,5 +3746,5 @@ @@ -3763,5 +3768,5 @@@@ -4259,5 +4264,5 @@
@@ -4308,5 +4313,5 @@
@@ -4361,5 +4366,5 @@
Clozure CL sets up logical pathname translations for logical hosts: ccl and home
The CCL logical host should point to the
ccl directory. It is used for a variety of
@@ -4515,5 +4520,5 @@
platforms.
-
+
CCL:MAP-FILE-TO-IVECTOR
pathname
@@ -4575,5 +4580,5 @@
a memory error.
-
+
CCL:UNMAP-IVECTOR
displaced-array
@@ -4587,5 +4592,5 @@
target is an empty vector (of length zero).
-
+
CCL:MAP-FILE-TO-OCTET-VECTOR
pathname
@@ -4597,5 +4602,5 @@
bytes.
-
+
CCL:UNMAP-OCTET-VECTOR
displaced-array
@@ -4636,5 +4641,5 @@
static.
Clozure CL provides the
function CCL:SAVE-APPLICATION, which creates a file
@@ -4770,5 +4775,5 @@
converted, because address 0 can always be relied upon to refer to
the same thing.
As of Clozure CL 1.2, the constant CCL:+NULL-PTR+
refers to a MACPTR object that points to address 0.
ccl64 script.
-
+
SAVE-APPLICATION
@@ -5056,5 +5061,5 @@
@@ -5103,5 +5108,5 @@
@@ -5161,5 +5166,5 @@
@@ -5335,5 +5340,5 @@
@@ -5369,5 +5374,5 @@
@@ -5455,5 +5460,5 @@
Because the code coverage information is associated with compiled
- functions, load-time toplevel expressions do not get reported
- on. You can work around this by creating a function and calling
+ functions, code coverage information is not available for load-time toplevel
+ expressions. You can work around this by creating a function and calling
it. I.e. instead of
Then you can see the coverage information in the definition of
-init-this-and-that.
+
output-file---
+ Pathname for the output index file.
+ html---
- If non-nil, this will generate an HTML report, consisting of
- an index file and one html file for each instrumented source
- file that has been loaded in the current session. The
- individual source file reports are stored in the same
- directory as the index file.
+ If non-nil (the default), this will generate an HTML report, consisting of
+ an index file in output-file and, in the same directory,
+ one html file for each instrumented source file that has been loaded in the
+ current session.
external-format---
@@ -5712,14 +5719,14 @@
statistics---
- If :statistics is non-nil, a comma-separated file is also
+ If non-nil (the default), a comma-separated file is also
generated with the summary of statistics. You can specify a
filename for the statistics argument, otherwise
- "statistics.csv" is created in the output directory. See
- documentation of ccl:coverage-statistics below for a
+ "statistics.csv" is created in the directory of output-file.
+ See documentation of coverage-statistics below for a
description of the values in the statistics file.
@@ -5729,5 +5736,5 @@
@@ -5746,5 +5753,5 @@
[Function]
Resets all coverage data back to the "Not Executed" state
@@ -5768,5 +5775,5 @@
[Function]
Gets rid of the information about which instrumented files have
@@ -5803,6 +5810,6 @@
Saves all coverage info in a file, so you can restore the
@@ -5829,9 +5836,9 @@
Restores the coverage data previously saved with
- CCL:SAVE-COVERAGE-IN-FILE, for the set of instrumented fasls
+ ccl:save-coverage-in-file, for the set of instrumented fasls
that were loaded both at save and restore time. I.e. coverage
info is only restored for files that have been loaded in this
@@ -5839,5 +5846,5 @@
"foo.lx86fsl" and then saved the coverage info, in this session
you must load the same "foo.lx86fsl" before calling
- ccl:restore-coverage-from-file in order to retrieve the stored
+ restore-coverage-from-file in order to retrieve the stored
coverage info for "foo". Equivalent to (ccl:restore-coverage
(ccl:read-coverage-from-file pathname)).
@@ -5851,5 +5858,5 @@
[Function]
Returns a snapshot of the current coverage data. A snapshot is a
@@ -5887,8 +5894,32 @@
+
+
+ Takes a list of coverage snapshots and returns a new coverage snapshot
+ representing a union of all the coverage data.
Saves the coverage snapshot in a file. The snapshot can be
@@ -5937,6 +5968,6 @@
Returns the snapshot saved in pathname. Doesn't affect the
@@ -5958,5 +5989,5 @@
Returns a sequence ccl:coverage-statistics objects, one for each
@@ -5977,5 +6008,5 @@
- ccl:coverage-source-file
+ coverage-source-file
@@ -5989,5 +6020,5 @@
- ccl:coverage-expressions-total
+ coverage-expressions-total
@@ -6001,5 +6032,5 @@
- ccl:coverage-expressions-entered
+ coverage-expressions-entered
@@ -6014,5 +6045,5 @@
- ccl:coverage-expressions-covered
+ coverage-expressions-covered
@@ -6026,5 +6057,5 @@
- ccl:coverage-unreached-branches
+ coverage-unreached-branches
@@ -6038,5 +6069,5 @@
- ccl:coverage-code-forms-total
+ coverage-code-forms-total
@@ -6052,5 +6083,5 @@
- ccl:coverage-code-forms-covered
+ coverage-code-forms-covered
@@ -6064,5 +6095,5 @@
- ccl:coverage-functions-total
+ coverage-functions-total
@@ -6076,5 +6107,5 @@
- ccl:coverage-functions-fully-covered
+ coverage-functions-fully-covered
@@ -6088,5 +6119,5 @@
- ccl:coverage-functions-partly-covered
+ coverage-functions-partly-covered
@@ -6100,5 +6131,5 @@
- ccl:coverage-functions-not-entered
+ coverage-functions-not-entered
@@ -6125,5 +6156,5 @@
This variable controls whether functions are instrumented for
@@ -6156,6 +6187,6 @@
This macro arranges so that body doesn't record internal details
@@ -6168,4 +6199,44 @@
+
+ The output of ccl:report-coverage consists of formatted source code, with coverage indicated by
+ coloring. Four colors are used: dark green for forms that compiled to code in which every single
+ instruction was executed, light green for forms that have been entered but weren't totally covered, red
+ for forms that were never entered, and the page background color for toplevel forms that weren't
+ instrumented.
+
+
+ The source coloring is applied from outside in. So for example if you have
+
+
+
+ first the whole outer form is painted with whatever color expresses the outer form coverage, and then the
+ inner form color is replaced with whatever color expresses the inner form coverage. One consequence of
+ this approach is that every part of the outer form that is not specifically inside some executable inner
+ form will have the outer form's coverage color. If the syntax of outer form involves some non-executable
+ forms, or forms that do not have coverage info of their own for whatever reason, then they will just
+ inherit the color of the outer form, because it doesn't get replaced with a color of its own.
+
+ One case in which this approach can be confusing is in the case of symbols. As noted in the Limitations
+ section, coverage information is not recorded for variables; hence the coloring of a variable does not
+ convey information about whether the variable was evaluated or not -- that information is not available,
+ and the variable just inherits the color of the form that contains it.
+
@@ -6227,5 +6298,5 @@
@@ -6258,5 +6329,5 @@
@@ -6488,5 +6559,5 @@
-
+
BUILD-APPLICATION &key
( process-suspend was previously called
@@ -7815,5 +7886,5 @@
@@ -7868,5 +7939,5 @@
It would be nice to have more discussion of what it means
@@ -8012,5 +8083,5 @@
It would probably be better for result
@@ -8151,10 +8222,10 @@
This should arguably be SETFable, but doesn't seem to
@@ -8443,5 +8514,5 @@
Advises the OS scheduler that the current thread has nothing
@@ -8452,10 +8523,10 @@
This is a holdover from the days of cooperative
@@ -8480,5 +8551,5 @@
Executes body
@@ -8661,5 +8732,5 @@
Creates and returns an object of type CCL::READ-WRITE-LOCK.
@@ -8867,10 +8938,10 @@
There probably should be some way to
@@ -8895,5 +8966,5 @@
result should probably be interpreted
@@ -9058,5 +9129,5 @@
result should probably be interpreted
@@ -9102,5 +9173,5 @@
fd---a file descriptor, which is a non-negative integer
@@ -9152,5 +9223,5 @@
@@ -9198,5 +9269,5 @@
fd---a file descriptor, which is a non-negative integer
@@ -9206,5 +9277,5 @@
@@ -9249,5 +9320,5 @@
process---a process, typically created by process-run-function or by make-process Waits for the specified process to terminate. If the
@@ -9516,5 +9587,5 @@
address-family---The address/protocol family of this socket. Currently
@@ -9616,5 +9687,5 @@
Creates and returns a new socket Extracts the first connection on the queue of pending
@@ -9669,5 +9740,5 @@
Converts a dotted-string representation of a host address to
@@ -9697,5 +9768,5 @@
ipaddr---A 32-bit integer representing an internet host address Converts a 32-bit unsigned IP address into octets. ipaddr---a 32-bit integer representing an internet host address Converts a 32-bit unsigned IP address into a host name
@@ -9752,5 +9823,5 @@
host---Specifies the host. It can be either a host name
@@ -9760,5 +9831,5 @@
Converts a host spec in any of the acceptable formats into a
@@ -9780,5 +9851,5 @@
port---Specifies the port. It can be either a string, such as
@@ -9789,5 +9860,5 @@
Finds the port number for the specified port and protocol Reads a UDP packet from a socket. If no packets are
@@ -9863,5 +9934,5 @@
Send a UDP packet over a socket. socket---The socket to shut down (typically a tcp-stream) Shuts down part of a bidirectional connection. This is
@@ -9925,10 +9996,10 @@
Returns the native OS's representation of the socket, or
@@ -9955,10 +10026,10 @@
Returns the 32-bit unsigned IP address of the remote host,
@@ -9980,10 +10051,10 @@
Returns the remote port number, or NIL if the socket is not
@@ -10005,10 +10076,10 @@
Returns 32-bit unsigned IP address of the local host. Returns the local port number Returns :internet or :file, as appropriate. Returns :active for tcp-stream, :passive for
@@ -10102,10 +10173,10 @@
Returns the socket format as specified by the :format
@@ -10127,10 +10198,10 @@
returns :stream for tcp-stream and listener-socket, and
@@ -10151,10 +10222,10 @@
simple-error The OS error code of the error A symbol representing the error code in a more
@@ -10228,10 +10299,10 @@
A string describing the context where the error happened. On
@@ -10254,5 +10325,5 @@
The close generic function can be applied to sockets. It
@@ -10286,5 +10357,5 @@
executes body with var bound to the result of applying
@@ -10425,5 +10496,5 @@
program---A string or pathname which denotes an executable file.
@@ -10476,5 +10547,5 @@
Runs the specified program in an external (Unix) process,
@@ -10496,5 +10567,5 @@
proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM. Sends the specified "signal" to the specified
@@ -10525,10 +10596,10 @@
Returns the process id assigned to
@@ -10552,10 +10623,10 @@
Returns the stream created when the input argument to
@@ -10578,10 +10649,10 @@
Returns the stream created when the output argument to
@@ -10605,10 +10676,10 @@
Returns the stream created when the error argument to
@@ -10632,10 +10703,10 @@
Returns, as multiple values, a keyword denoting the status
@@ -10667,5 +10738,5 @@
A stream that is associated with a file descriptor has
attributes and accessors:
@@ -10956,5 +11027,5 @@
stream---a stream, presumably a fundamental-input-stream. Should try to read up to count elements from stream into the
@@ -11507,5 +11578,5 @@
stream---a stream, presumably a fundamental-output-stream. should try to write the first count elements of list to
@@ -11538,5 +11609,5 @@
stream---a stream, presumably a fundamental-input-stream should try to read successive elements from stream into
@@ -11577,5 +11648,5 @@
stream---a stream, presumably a fundamental-output-stream should try to write successive elements of vector to stream,
@@ -11615,5 +11686,5 @@
Returns the file descriptor associated with
@@ -11656,5 +11727,5 @@
stream---An input stream. The method defined on
@@ -11688,5 +11759,5 @@
Writes max-octets octets to stream from ivector, starting at
@@ -11694,5 +11765,5 @@
CHUD:*SHARK-CONFIG-FILE*
[Variable] CHUD:METER form &key (reset nil)
+ CHUD:METER form &key (reset nil)
(debug-output nil) [Macro] Executes FORM (an arbitrary lisp form) and returns whatever
@@ -13982,5 +14053,5 @@
Reads a symbol from the current input stream, with *PACKAGE*
@@ -16075,5 +16146,5 @@
In In In In If completely is T, sets the
@@ -16349,5 +16420,5 @@
Proclaims name
@@ -16402,5 +16473,5 @@
filename
@@ -4982,5 +4987,5 @@
init-this-and-that.
- report-coverage &key
+ report-coverage output-file &key
(external-format :default) (statistics t) (html t)
-(CCL:REPORT-COVERAGE "/my/dir/coverage/report.html")
+(REPORT-COVERAGE "/my/dir/coverage/report.html")
- reset-coverage
+ RESET-COVERAGE
- clear-coverage
+ CLEAR-COVERAGE
- save-coverage
+ SAVE-COVERAGE
+(outer-form ... (inner-form ...) ...)
+
+ name "MyApplication")
@@ -6920,5 +6991,5 @@
@@ -12495,5 +12566,5 @@
CCL 1.2 and later, the #& reader macro can be used to
@@ -16134,5 +16205,5 @@
CCL 0.14.2 and later, the #? reader macro can be used
@@ -16181,5 +16252,5 @@
CCL 1.2 and later, the #/ reader macro can be used to
@@ -16284,5 +16355,5 @@
CCL 1.2 and later, the #> reader macro reads
@@ -16313,5 +16384,5 @@