Commit 4747ad7e authored by Robert P. Goldman's avatar Robert P. Goldman
Browse files

Documentation of :here directive improved with guidance from Xach.

parent d1793fe3
Loading
Loading
Loading
Loading
+16 −1
Original line number Diff line number Diff line
@@ -1904,8 +1904,12 @@ alone in its directory with the following contents:

@subsection The :here directive

The @code{:here} directive is an absolute pathname designator that
refers to the directory containing the configuration file currently
being processed.

The @code{:here} directive is intended to simplify the delivery of
complex libraries, and for easy configuration of projects shared through
complex CL systems, and for easy configuration of projects shared through
revision control systems, in accordance with our design principle that
each participant should be able to provide all and only the information
available to him or her.
@@ -1932,6 +1936,17 @@ contains the following:
   (:directory (:here "outlier/")))
@end example

Then when someone else (call her Y) checks out a copy of this
repository, she need only add 
@example
(:include "/path/to/my/checkout/directory/asdf.conf")
@end example
to one of her previously-existing asdf source location configuration
files, or invoke @code{initialize-source-registry} with a configuration
form containing that s-expression.  ASDF will find the .conf file that X
has provided, and then set up source locations within the working
directory according to X's (relative) instructions.

@section Shell-friendly syntax for configuration

When considering environment variable @code{CL_SOURCE_REGISTRY}