Mercurial > hg > octave-shane

changeset 16846:e6401864d791

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: fix documentation about packages. * package.txi: the pre_install, post_install, and on_uninstall files on packages are called as Octave functions, not scripts. Describe the argument passed to this functions.
author Carnë Draug <carandraug+dev@gmail.com>
date Tue, 25 Jun 2013 15:39:47 +0200
parents 9d1d8bdd71de
children 474e6d189de1
files doc/interpreter/package.txi
diffstat 1 files changed, 13 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/package.txi
+++ b/doc/interpreter/package.txi
@@ -252,16 +252,23 @@
 directives.
 
 @item package/pre_install.m
-This is an optional script that is run prior to the installation of a
-package. 
+This is an optional function that is run prior to the installation of a
+package.  This function is called with a single argument, a struct with
+fields names after the data in the @file{DESCRIPTION}, and the paths where
+the package functions will be installed.
 
 @item package/post_install.m
-This is an optional script that is run after the installation of a
-package. 
+This is an optional function that is run after the installation of a
+package.  This function is called with a single argument, a struct with
+fields names after the data in the @file{DESCRIPTION}, and the paths where
+the package functions were installed.
 
 @item package/on_uninstall.m
-This is an optional script that is run prior to the removal of a
-package. 
+This is an optional function that is run prior to the removal of a
+package.  This function is called with a single argument, a struct with
+fields names after the data in the @file{DESCRIPTION}, the paths where
+the package functions are installed, and whether the package is currently
+loaded.
 @end table
 
 Besides the above mentioned files, a package can also contain on or