bug#11647: 24.1; Document return value of load-source-file-function

bug#11647: 24.1; Document return value of load-source-file-function

[Christopher Schmidt]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: load-source-file-function.diff --]
[-- Type: text/x-diff, Size: 1058 bytes --]

=== modified file 'src/ChangeLog'
--- src/ChangeLog	2012-06-07 05:11:51 +0000
+++ src/ChangeLog	2012-06-08 01:42:27 +0000
@@ -1,3 +1,8 @@
+2012-06-08  Christopher Schmidt  <christopher@ch.ristopher.com>
+
+	* lread.c (syms_of_lread): Document return value of
+	load-source-file-function.
+
 2012-06-07  Paul Eggert  <eggert@cs.ucla.edu>
 
 	* doprnt.c (doprnt): Truncate multibyte char correctly.

=== modified file 'src/lread.c'
--- src/lread.c	2012-05-30 03:59:42 +0000
+++ src/lread.c	2012-06-08 01:53:34 +0000
@@ -4508,7 +4508,8 @@
 
   DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
 	       doc: /* Function called in `load' for loading an Emacs Lisp source file.
-This function is for doing code conversion before reading the source file.
+This function is for doing code conversion before reading the source
+file.  It should return t if the file exists and loads successfully.
 If nil, loading is done without any code conversion.
 Arguments are FULLNAME, FILE, NOERROR, NOMESSAGE, where
  FULLNAME is the full name of FILE.


[-- Attachment #2: Type: text/plain, Size: 123 bytes --]


Unfortunately I cannot get the trunk to build so the patch is untested.
It's just a doc fix, though.

        Christopher

bug#11647: 24.1; Document return value of load-source-file-function

[Christopher Schmidt]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: load-source-file-function.diff --]
[-- Type: text/x-diff, Size: 1417 bytes --]

=== modified file 'src/ChangeLog'
--- src/ChangeLog	2012-06-24 04:11:19 +0000
+++ src/ChangeLog	2012-06-24 15:24:00 +0000
@@ -1,3 +1,7 @@
+2012-06-24  Christopher Schmidt  <christopher@ch.ristopher.com>
+
+	* lread.c (syms_of_lread): Doc fix (Bug#11647).
+
 2012-06-24  Paul Eggert  <eggert@cs.ucla.edu>
 
 	Fix bug when time_t is unsigned and as wide as intmax_t (Bug#9000).

=== modified file 'src/lread.c'
--- src/lread.c	2012-06-22 21:17:42 +0000
+++ src/lread.c	2012-06-24 15:22:30 +0000
@@ -4501,11 +4501,11 @@
 
   DEFVAR_LISP ("load-source-file-function", Vload_source_file_function,
 	       doc: /* Function called in `load' for loading an Emacs Lisp source file.
-This function is for doing code conversion before reading the source file.
-If nil, loading is done without any code conversion.
-Arguments are FULLNAME, FILE, NOERROR, NOMESSAGE, where
- FULLNAME is the full name of FILE.
-See `load' for the meaning of the remaining arguments.  */);
+This function is for doing code conversion before reading the source
+file.  It should return t if the file exists and loads successfully.
+If nil, loading is done without any code conversion.  Arguments are
+FULLNAME, FILE, NOERROR, NOMESSAGE, where FULLNAME is the full name of
+FILE.  See `load' for the meaning of the remaining arguments.  */);
   Vload_source_file_function = Qnil;
 
   DEFVAR_BOOL ("load-force-doc-strings", load_force_doc_strings,


[-- Attachment #2: Type: text/plain, Size: 36 bytes --]


OK to commit?

        Christopher

bug#11647: 24.1; Document return value of load-source-file-function

[Chong Yidong]

> +2012-06-24  Christopher Schmidt  <christopher@ch.ristopher.com>
> +
> +	* lread.c (syms_of_lread): Doc fix (Bug#11647).
> +

Sorry for the delay.  I've now committed a tweaked version of this
patch.