who-references

$Revision: 5.0.2.4 $

Function

Package: CROSS-REFERENCE

Arguments: (name &key inverse in-files in-functions stream)

When the value of the inverse argument is nil (the default), this function prints information in the database about those functions which reference the global variable identified by name. When the value of the inverse argument is true, this function prints information on the global variables referenced by the function identified by name.

When inverse is nil, name can be any lisp object but only global variables make sense as the value (no cross reference information is gathered for other types of Lisp object). When inverse is true, name must be a function name (either a symbol or a list of the type described the discussion of function specs in implementation.htm).

The in-functions and in-files keyword arguments can be used to restrict the search to particular functions (for in-functions) or functions defined in particular files (for in-files). The default value for each argument is nil, which calls for an unrestricted search. When inverse is nil (so a list of functions is printed by this function) a non-nil value for in-functions or in-files should be a list of function names or file names (respectively) and the information printed will be the intersection of the functions found in the database and the functions in the list or defined in files in the list (respectively). Note that source file information must have been recorded for the files in the in-files list. When inverse is true (so this functions is printing the list of global variables referenced by the function identified by name), the list that is the value of in-functions should be a list of global variables and only those found in the database and in the list will be printed.

This functions does not return any value. The information is printed to the stream specified by the stream keyword argument, which defaults to *standard-output*. The function xref:get-relation can be used when you wish information returned rather than printed.

The top-level command :who-references calls this function.

See cross_reference.htm for more information on the cross reference facility.

The general documentation description is in introduction.htm. The index in index.htm.