Mercurial > hg > octave-terminal
changeset 10980:1cbfb15892c9
addpath, rmpath: document path arguments
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 15 Sep 2010 14:43:30 -0400 |
parents | 7f49dc864f32 |
children | 536073428182 |
files | src/ChangeLog src/load-path.cc |
diffstat | 2 files changed, 18 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2010-09-15 John W. Eaton <jwe@octave.org> + + * load-path.cc (Faddpath, Frmpath): Document path arguments. + 2010-09-15 John Swensen <jpswensen@gmail.com> * __magick_read__.cc: Allow image_write to write filetypes
--- a/src/load-path.cc +++ b/src/load-path.cc @@ -2011,7 +2011,7 @@ current load path.\n\ \n\ If @var{nargin} is greater than zero, concatenate the arguments,\n\ -separating them with @code{pathsep()}. Set the internal search path\n\ +separating them with @code{pathsep}. Set the internal search path\n\ to the result and return it.\n\ \n\ No checks are made for duplicate elements.\n\ @@ -2064,6 +2064,13 @@ directory name to the current path. If @var{option} is @samp{\"-end\"}\n\ or 1, append the directory name to the current path.\n\ Directories added to the path must exist.\n\ +\n\ +In addition to accepting individual directory arguments, lists of\n\ +directory names separated by @code{pathsep} are also accepted. For example,\n +\n\ +@example\n\ +addpath (\"dir1:/dir2:~/dir3\");\n\ +@end example\n\ @seealso{path, rmpath, genpath, pathdef, savepath, pathsep}\n\ @end deftypefn") { @@ -2169,6 +2176,12 @@ @deftypefn {Built-in Function} {} rmpath (@var{dir1}, @dots{})\n\ Remove @var{dir1}, @dots{} from the current function search path.\n\ \n\ +In addition to accepting individual directory arguments, lists of\n\ +directory names separated by @code{pathsep} are also accepted. For example,\n +\n\ +@example\n\ +rmpath (\"dir1:/dir2:~/dir3\");\n\ +@end example\n\ @seealso{path, addpath, genpath, pathdef, savepath, pathsep}\n\ @end deftypefn") {