From eca1979079a120029fabfee4b4d5ce1fc0e8295a Mon Sep 17 00:00:00 2001
From: "Robert P. Goldman" <rpgoldman@real-time.com>
Date: Thu, 24 Jun 2010 13:14:03 -0500
Subject: [PATCH] Added docstrings for behavior variables.

Added docstrings for *compile-file-warnings-behaviour* and
*compile-file-failure-behaviour*.
---
 asdf.lisp | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/asdf.lisp b/asdf.lisp
index 776eda71..a38c02ef 100644
--- a/asdf.lisp
+++ b/asdf.lisp
@@ -344,9 +344,15 @@ You can compare this string with e.g.:
 
 Defaults to `t`.")
 
-(defvar *compile-file-warnings-behaviour* :warn)
-
-(defvar *compile-file-failure-behaviour* #+sbcl :error #-sbcl :warn)
+(defvar *compile-file-warnings-behaviour* :warn
+  "How should ASDF react if it encounters a warning when compiling a
+file?  Valid values are :error, :warn, and :ignore.")
+
+(defvar *compile-file-failure-behaviour* #+sbcl :error #-sbcl :warn
+        "How should ASDF react if it encounters a failure \(per the
+ANSI spec of COMPILE-FILE\) when compiling a file?  Valid values are
+:error, :warn, and :ignore.  Note that ASDF ALWAYS raises an error
+if it fails to create an output file when compiling.")
 
 (defvar *verbose-out* nil)
 
-- 
GitLab