diff libinterp/corefcn/load-path.cc @ 22387:4e97eaf021e4

doc: add note about PKG_ADD/PKG_DEL to addpath and rmpath (bug #41885) * load-path.cc (Faddpath): Add documentation to explain that PKG_ADD is run if it exists. (Frmpath): Add documentation to explain that PKG_DEL is run if it exists.
author Julien Bect <julien.bect@supelec.fr>
date Sun, 16 Mar 2014 22:07:07 +0100
parents d0562b3159c7
children 34ce5be04942
line wrap: on
line diff
--- a/libinterp/corefcn/load-path.cc	Thu Aug 25 14:01:45 2016 +0200
+++ b/libinterp/corefcn/load-path.cc	Sun Mar 16 22:07:07 2014 +0100
@@ -2399,6 +2399,11 @@
 @example
 addpath ("dir1:/dir2:~/dir3")
 @end example
+
+For each directory that is added, and that was not already in the path,
+@code{addpath} checks for the existence of a file named @file{PKG_ADD}
+(note lack of .m extension) and runs it if it exists.
+
 @seealso{path, rmpath, genpath, pathdef, savepath, pathsep}
 @end deftypefn */)
 {
@@ -2500,6 +2505,11 @@
 @example
 rmpath ("dir1:/dir2:~/dir3")
 @end example
+
+For each directory that is removed, @code{rmpath} checks for the
+existence of a file named @file{PKG_DEL} (note lack of .m extension)
+and runs it if it exists.
+
 @seealso{path, addpath, genpath, pathdef, savepath, pathsep}
 @end deftypefn */)
 {