--- Begin Message ---
package octave2.9
tags 416046 = upstream patch
thanks
I am forwarding below a bug report filed against the octave2.9 package in
Debian. The full context can be seen at the Debian BTS [1]. The bug
reporter is correctly complaining that the docs are outdated regarding the
old built-in variables LOADPATH, INFO_FILES, and INFO_PROGRAM. Please,
consider the attached patch against the CVS sources, in which I tried to
chase down all the references to the variables above. Changelog entries are
also provided.
[1] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=416046
Rafael
* depuis <pascal.dupuis@worldonline.be> [2007-03-28 08:41]:
> ---------- Initial header -----------
>
> >From : "Rafael Laboissiere" rafael@debian.org
> To : "Pascal A. Dupuis"
> Pascal.Dupuis@worldonline.be,416046@bugs.debian.org
> CC : control@bugs.debian.org
> Date : Tue, 27 Mar 2007 20:37:55 +0200
> Subject : Re: [Pkg-octave-devel] Bug#416046: octave2.9: pathdef doesn't
> include dir with info-emacs-info and info-emacs-octave-help
>
> > package octave2.9
> > tags 416046 moreinfo
> > thanks
> >
> > * Pascal A. Dupuis <Pascal.Dupuis@worldonline.be> [2007-03-24 11:55]:
> >
> > > Package: octave2.9
> > > Severity: normal
> > >
> > > Hello,
> > > while trying to understand why the info mode didn't work as expected in
> > > octave2.9 running under emacs, I found that the required "programs"
> > > (shell scripts calling gnudoit), info-emacs-info & info-emacs-octave-help,
> > > are placed under
> > > /usr/lib/octave/2.9.9/exec/i486-pc-linux-gnu
> > >
> > > This dir does not appear in pathdef, so both functions are unknown.
> > > Could you please solve it ?
> >
> > I am puzzled by this bug report. The path returned by pathdef() is used
> > only for finding *.m and *.oct files and not the executables in
> > /usr/lib/octave/<version>/exec/<arch>. BTW, the following works perfectly
> > for me:
> >
> > $ sudo apt-get install emacs21 gnuserv octave2.9 octave2.9-info
> > $ emacs -eval "(gnuserv-start)" &
> > $ octave2.9
> > octave2.9:1> info_program ("info-emacs-info")
> > octave2.9:2> doc
> >
> > I see then the info directory in my emacs frame. Does this work for you?
> >
> > I may have misunderstood your problem. At any rate, I am tagging this bug
> > report "moreinfo", meaning that if we do not receive further informations in
> > a reasonable time frame I will close this bug report.
> >
> > --
> > Rafael
> >
>
> OK. Understood.
> Under octave2.1, the equivalent was:
> INFO_PROGRAM = "info-emacs-info";
>
> It thus changed from a variable to a function.
>
> Now, there are some discrenpancies into the documentation:
> octave2.9-info states:
> `--info-program PROGRAM'
> Specify the name of the info program to use. The value of PROGRAM
> specified on the command line will override any value of
> `OCTAVE_INFO_PROGRAM' found in the environment, but not any
> commands in the system or user startup files that set the built-in
> variable `INFO_PROGRAM'.
> and
> `INFO_PROGRAM'
> *Note Getting Help::.
>
> Default value:
> `"OCTAVE-HOME/libexec/octave/VERSION/exec/ARCH/info"'.
> in E.4 Using the Emacs Info Reader for Octave
> You can use either `plain' Emacs Info or the function `octave-help'
> as your Octave info reader (for `help -i'). In the former case, set
> the Octave variable `INFO_PROGRAM' to `"info-emacs-info"'. The latter
> is perhaps more attractive because it allows to look up keys in the
> indices of _several_ info files related to Octave (provided that the
> Emacs variable `octave-help-files' is set correctly). In this case,
> set `INFO_PROGRAM' to `"info-emacs-octave-help"'.
>
> It seems that some documented variables don't exist anymore (octave2.9.9,
> debian testing) : DEFAULT_LOADPATH, INFO_FILE, INFO_PROGRAM, LOADPATH ? OTOH,
> things like 'EDITOR' and 'PS1' are now listed as 'built-in functions' ?
>
> Best regards
>
> Pascal Dupuis
--
Rafael
Index: ChangeLog
===================================================================
RCS file: /cvs/octave/ChangeLog,v
retrieving revision 1.597
diff -u -r1.597 ChangeLog
--- ChangeLog 27 Mar 2007 16:05:15 -0000 1.597
+++ ChangeLog 28 Mar 2007 13:26:16 -0000
@@ -1,3 +1,8 @@
+2007-03-28 Rafael Laboissiere <rafael@debian.org>
+
+ * emacs/octave-mod.el: Drop LOADPATH, INFO_FILE, and
+ INFO_PROGRAM from octave-variables.
+
2007-03-27 John W. Eaton <jwe@octave.org>
* octMakefile.in (dist, conf-dist): Use ln, not $(LN_S).
Index: doc/ChangeLog
===================================================================
RCS file: /cvs/octave/doc/ChangeLog,v
retrieving revision 1.127
diff -u -r1.127 ChangeLog
--- doc/ChangeLog 27 Mar 2007 16:05:15 -0000 1.127
+++ doc/ChangeLog 28 Mar 2007 13:26:16 -0000
@@ -1,3 +1,15 @@
+2007-03-28 Rafael Laboissiere <rafael@debian.org>
+
+ * faq/Octave-FAQ.texi, interpreter/basics.txi,
+ interpreter/emacs.txi, interpreter/func.tx, interpreter/var.txi:
+ Make it clear that the old built-in LOADPATH is an internal
+ variable, accessible through path (). Also dropped references to
+ DEFAULT_LOADPATH. Changed references to the old built-in variables
+ INFO_FILE and INFO_PROGRAM to the respective fucntions info_file
+ and info_program.
+ * refcard/refcard.tex: Dropped LOADPATH from list of build-in
+ variables.
+
2007-03-27 John W. Eaton <jwe@octave.org>
* Makefile.in, interpreter/Makefile.in, faq/Makefile.in,
Index: doc/faq/Octave-FAQ.texi
===================================================================
RCS file: /cvs/octave/doc/faq/Octave-FAQ.texi,v
retrieving revision 1.18
diff -u -r1.18 Octave-FAQ.texi
--- doc/faq/Octave-FAQ.texi 28 Jul 2005 19:27:57 -0000 1.18
+++ doc/faq/Octave-FAQ.texi 28 Mar 2007 13:26:16 -0000
@@ -623,11 +623,12 @@
@item
Octave takes a long time to find symbols.
-Octave is probably spending this time recursively searching directories
-for function files. Check the value of your LOADPATH. For those
+Octave is probably spending this time recursively searching directories for
+function files. Check the value of the internal variable LOADPATH,
+accessible through the Octave fucntion @code{path}. For those
elements that end in @samp{//}, do any name a very large directory tree?
-Does it contain directories that have a mixture of files and
-directories? In order for the recursive directory searching code to
+Does it contain directories that have a mixture of files and
+directories? In order for the recursive directory searching code to
work efficiently, directories that are to be searched recursively should
have either function files only, or subdirectories only, but not a
mixture of both. Check to make sure that Octave's standard set of
Index: doc/interpreter/basics.txi
===================================================================
RCS file: /cvs/octave/doc/interpreter/basics.txi,v
retrieving revision 1.22
diff -u -r1.22 basics.txi
--- doc/interpreter/basics.txi 24 Apr 2006 19:13:06 -0000 1.22
+++ doc/interpreter/basics.txi 28 Mar 2007 13:26:17 -0000
@@ -91,16 +91,16 @@
Specify the name of the info file to use. The value of @var{filename}
specified on the command line will override any value of
@code{OCTAVE_INFO_FILE} found in the environment, but not any commands
-in the system or user startup files that set the built-in variable
-@code{INFO_FILE}.
+in the system or user startup files that use the the @code{info_file}
+function.
@item --info-program @var{program}
@cindex @code{--info-program @var{program}}
Specify the name of the info program to use. The value of @var{program}
specified on the command line will override any value of
@code{OCTAVE_INFO_PROGRAM} found in the environment, but not any
-commands in the system or user startup files that set the built-in
-variable @code{INFO_PROGRAM}.
+commands in the system or user startup files that use the
+@code{info_program} function.
@item --interactive
@itemx -i
@@ -141,7 +141,8 @@
Specify the path to search for function files. The value of @var{path}
specified on the command line will override any value of
@code{OCTAVE_PATH} found in the environment, but not any commands in the
-system or user startup files that set the built-in variable @code{LOADPATH}.
+system or user startup files that set the internal variable @code{LOADPATH}
+through one of the path functions.
@item --persist
Go to interactive mode after @code{--eval} or reading from a file
@@ -297,11 +298,11 @@
comma and semicolons that are used as command separators. To get help
for those, you must type @kbd{help comma} or @kbd{help semicolon}.
-@DOCSTRING(INFO_FILE)
+@DOCSTRING(info_file)
-@DOCSTRING(INFO_PROGRAM)
+@DOCSTRING(info_program)
-@DOCSTRING(MAKEINFO_PROGRAM)
+@DOCSTRING(makeinfo_program)
@DOCSTRING(suppress_verbose_help_message)
Index: doc/interpreter/emacs.txi
===================================================================
RCS file: /cvs/octave/doc/interpreter/emacs.txi,v
retrieving revision 1.7
diff -u -r1.7 emacs.txi
--- doc/interpreter/emacs.txi 24 Oct 2006 01:00:12 -0000 1.7
+++ doc/interpreter/emacs.txi 28 Mar 2007 13:26:17 -0000
@@ -328,7 +328,7 @@
@code{font-lock-reference-face}
@item
the builtin variables (such as @samp{warn_fortran_indexing}, @samp{NaN}
-or @samp{LOADPATH}) in @code{font-lock-variable-name-face}
+or @samp{EDITOR}) in @code{font-lock-variable-name-face}
@item
and the function names in function declarations in
@code{font-lock-function-name-face}.
@@ -488,11 +488,11 @@
You can use either `plain' Emacs Info or the function @code{octave-help}
as your Octave info reader (for @samp{help -i}). In the former case,
-set the Octave variable @code{INFO_PROGRAM} to @code{"info-emacs-info"}.
+use @code{info_program ("info-emacs-info")}.
The latter is perhaps more attractive because it allows to look up keys
in the indices of @emph{several} info files related to Octave (provided
that the Emacs variable @code{octave-help-files} is set correctly). In
-this case, set @code{INFO_PROGRAM} to @code{"info-emacs-octave-help"}.
+this case, use @code{info_program ("info-emacs-octave-help")}.
If you use Octave from within Emacs, these settings are best done in the
@file{~/.emacs-octave} startup file (or the file pointed to by the Emacs
Index: doc/interpreter/func.txi
===================================================================
RCS file: /cvs/octave/doc/interpreter/func.txi,v
retrieving revision 1.15
diff -u -r1.15 func.txi
--- doc/interpreter/func.txi 24 Apr 2006 19:13:06 -0000 1.15
+++ doc/interpreter/func.txi 28 Mar 2007 13:26:17 -0000
@@ -398,7 +398,7 @@
When Octave encounters an identifier that is undefined, it first looks
for variables or functions that are already compiled and currently
listed in its symbol table. If it fails to find a definition there, it
-searches the list of directories specified by the built-in variable
+searches the list of directories specified by the internal variable
@code{LOADPATH} for files ending in @file{.m} that have the same base
name as the undefined identifier.@footnote{The @samp{.m} suffix was
chosen for compatibility with @sc{Matlab}.} Once Octave finds a file
@@ -437,9 +437,7 @@
@c FIXME -- note about time stamps on files in NFS environments?
-@DOCSTRING(DEFAULT_LOADPATH)
-
-@DOCSTRING(LOADPATH)
+@DOCSTRING(path)
@DOCSTRING(rehash)
@@ -491,10 +489,11 @@
@end example
To have Octave read and compile these functions into an internal form,
-you need to make sure that the file is in Octave's @code{LOADPATH}, then
-simply type the base name of the file that contains the commands.
-(Octave uses the same rules to search for script files as it does to
-search for function files.)
+you need to make sure that the file is in Octave's @code{LOADPATH}
+(accessible through the @code{path} function), then simply type the
+base name of the file that contains the commands. (Octave uses the
+same rules to search for script files as it does to search for
+function files.)
If the first token in a file (ignoring comments) is @code{function},
Octave will compile the function and try to execute it, printing a
@@ -529,7 +528,7 @@
following code will always print @samp{bar = 3} whether it is typed
directly on the command line, read from a script file, or is part of a
function body, even if there is a function or script file called
-@file{bar.m} in Octave's @code{LOADPATH}.
+@file{bar.m} in Octave's path.
@example
@group
Index: doc/interpreter/var.txi
===================================================================
RCS file: /cvs/octave/doc/interpreter/var.txi,v
retrieving revision 1.25
diff -u -r1.25 var.txi
--- doc/interpreter/var.txi 22 Feb 2007 18:57:38 -0000 1.25
+++ doc/interpreter/var.txi 28 Mar 2007 13:26:17 -0000
@@ -229,11 +229,6 @@
Octave was compiled (for example, @code{x86_64-unknown-linux-gnu}).
@vtable @code
-@item DEFAULT_LOADPATH
-@xref{Function Files}.
-
-Default value: @code{".:@var{octave-home}/lib/@var{version}"}.
-
@item EDITOR
@xref{Commands For History}.
@@ -244,22 +239,6 @@
Default value: @code{":$PATH"}.
-@item INFO_FILE
-@xref{Getting Help}.
-
-Default value: @code{"@var{octave-home}/info/octave.info"}.
-
-@item INFO_PROGRAM
-@xref{Getting Help}.
-
-Default value: @code{"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info"}.
-
-@item LOADPATH
-@xref{Function Files}.
-
-Default value: @code{":"}, which tells Octave to use the directories
-specified by the built-in variable @code{DEFAULT_LOADPATH}.
-
@item OCTAVE_HOME
Default value: @code{"@value{OCTAVEHOME}"}.
@@ -495,9 +474,9 @@
@section Defaults from the Environment
Octave uses the values of the following environment variables to set the
-default values for the corresponding built-in variables. In addition,
-the values from the environment may be overridden by command-line
-arguments. @xref{Command Line Options}.
+default values for the corresponding built-in or internal variables.
+In addition, the values from the environment may be overridden by
+command-line arguments. @xref{Command Line Options}.
@vtable @code
@item EDITOR
@@ -514,19 +493,19 @@
@item OCTAVE_PATH
@xref{Function Files}.
-Built-in variable: @code{LOADPATH}.
+Internal variable changed by function @code{path}.
Command-line argument: @code{--path}.
@item OCTAVE_INFO_FILE
@xref{Getting Help}.
-Built-in variable: @code{INFO_FILE}.
+Internal variable changed by function @code{info_file}.
Command-line argument: @code{--info-file}.
@item OCTAVE_INFO_PROGRAM
@xref{Getting Help}.
-Built-in variable: @code{INFO_PROGRAM}.
+Internal variable changed by function @code{info_program}.
Command-line argument: @code{--info-program}.
@item OCTAVE_HISTSIZE
Index: doc/refcard/refcard.tex
===================================================================
RCS file: /cvs/octave/doc/refcard/refcard.tex,v
retrieving revision 1.7
diff -u -r1.7 refcard.tex
--- doc/refcard/refcard.tex 26 Apr 2005 19:24:27 -0000 1.7
+++ doc/refcard/refcard.tex 28 Mar 2007 13:26:18 -0000
@@ -558,7 +558,6 @@
\sec Selected Built-in Variables;
EDITOR&editor to use with {\tt edit\_history}\cr
Inf, NaN&IEEE infinity, NaN\cr
-LOADPATH&path to search for function files\cr
PAGER&program to use to paginate output\cr
ans&last result not explicitly assigned\cr
eps&machine precision\cr
Index: emacs/octave-mod.el
===================================================================
RCS file: /cvs/octave/emacs/octave-mod.el,v
retrieving revision 1.41
diff -u -r1.41 octave-mod.el
--- emacs/octave-mod.el 14 Aug 2006 18:07:07 -0000 1.41
+++ emacs/octave-mod.el 28 Mar 2007 13:26:18 -0000
@@ -129,8 +129,8 @@
(defvar octave-variables
'("DEFAULT_EXEC_PATH" "DEFAULT_LOADPATH"
"EDITOR" "EXEC_PATH" "F_DUPFD" "F_GETFD" "F_GETFL" "F_SETFD"
- "F_SETFL" "I" "IMAGE_PATH" "INFO_FILE" "INFO_PROGRAM" "Inf" "J"
- "LOADPATH" "NaN" "OCTAVE_VERSION" "O_APPEND" "O_CREAT" "O_EXCL"
+ "F_SETFL" "I" "IMAGE_PATH" "Inf" "J"
+ "NaN" "OCTAVE_VERSION" "O_APPEND" "O_CREAT" "O_EXCL"
"O_NONBLOCK" "O_RDONLY" "O_RDWR" "O_TRUNC" "O_WRONLY" "PAGER" "PS1"
"PS2" "PS4" "PWD" "SEEK_CUR" "SEEK_END" "SEEK_SET" "__F_DUPFD__"
"__F_GETFD__" "__F_GETFL__" "__F_SETFD__" "__F_SETFL__" "__I__"
--- End Message ---