[Guile-commits] GNU Guile branch, master, updated. release_1-9-14-130-g043bca0

[Andy Wingo]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU Guile".

http://git.savannah.gnu.org/cgit/guile.git/commit/?id=043bca032670f55d79888ef7ead0b4a1a9480dce

The branch, master has been updated
       via  043bca032670f55d79888ef7ead0b4a1a9480dce (commit)
      from  b5c40589ecb249b8a0989c9409c37743c1f26557 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 043bca032670f55d79888ef7ead0b4a1a9480dce
Author: Andy Wingo <address@hidden>
Date:   Fri Jan 28 17:11:56 2011 +0100

    update api-evaluation.texi
    
    * doc/ref/api-evaluation.texi (Compilation): Update compile-file and
      compiled-file-name docs.

-----------------------------------------------------------------------

Summary of changes:
 doc/ref/api-evaluation.texi |   31 +++++++++++++++++++++----------
 1 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/doc/ref/api-evaluation.texi b/doc/ref/api-evaluation.texi
index 0a85ec9..54bdbef 100644
--- a/doc/ref/api-evaluation.texi
+++ b/doc/ref/api-evaluation.texi
@@ -607,24 +607,35 @@ For a discussion of languages and compiler options, 
@xref{Compiling to
 the Virtual Machine}.
 @end deffn
 
address@hidden {Scheme Procedure} compile-file file [to=objcode] [opts='()]
address@hidden {Scheme Procedure} compile-file file [output-file=#f] @
+  [from=(current-language)] [to='objcode] @
+  [env=(default-environment from)] [opts='()] @
+  [canonicalization 'relative]
 Compile the file named @var{file}.
 
-Output will be written to a file in the current directory whose name
-is computed as @code{(compiled-file-name @var{file})}.
+Output will be written to a @var{output-file}.   If you do not supply an
+output file name, output is written to a file in the cache directory, as
+computed by @code{(compiled-file-name @var{file})}.
+
address@hidden and @var{to} specify the source and target languages.
address@hidden to the Virtual Machine}, for more information on these
+options, and on @var{env} and @var{opts}.
 
 As with @command{guile-tools compile}, @var{file} is assumed to be
 UTF-8-encoded unless it contains a coding declaration.
 @end deffn
 
 @deffn {Scheme Procedure} compiled-file-name file
-Compute an appropriate name for a compiled version of a Scheme file
-named @var{file}.
-
-Usually, the result will be the original file name with the
address@hidden suffix replaced with @code{.go}, but the exact behavior
-depends on the contents of the @code{%load-extensions} and
address@hidden lists.
+Compute a cached location for a compiled version of a Scheme file named
address@hidden
+
+This file will usually be below the @file{$HOME/.cache/guile/ccache}
+directory, depending on the value of the @env{XDG_CACHE_HOME}
+environment variable.  The intention is that @code{compiled-file-name}
+provides a fallback location for caching auto-compiled files.  If you
+want to place a compile file in the @code{%load-compiled-path}, you
+should pass the @var{output-file} option to @code{compile-file},
+explicitly.
 @end deffn
 
 @node Loading


hooks/post-receive
-- 
GNU Guile