changeset 12561:0ade5992e374

Add documentation for '-forge' option (bug #32464).
author Rik <octave@nomad.inbox5.com>
date Thu, 31 Mar 2011 20:57:37 -0700
parents d6ad4ed57dda
children c686d2be0102
files scripts/ChangeLog scripts/pkg/get_forge_pkg.m scripts/pkg/module.mk scripts/pkg/pkg.m scripts/pkg/private/get_forge_pkg.m
diffstat 4 files changed, 17 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,9 @@
+2011-03-31  Rik  <octave@nomad.inbox5.com>
+
+	* pkg/module.mk, pkg/pkg.m, pkg/private/get_forge_pkg.m: Add
+	documentation for '-forge' option (bug #32464).  Make get_forge_pkg
+	a private function.
+
 2011-03-31  Marco Caliari  <marco.caliari@univr.it>
 
 	* sparse/spdiags.m: Treat empty vector (1x0 or 0x1) the same as diag().
--- a/scripts/pkg/module.mk
+++ b/scripts/pkg/module.mk
@@ -1,8 +1,11 @@
 FCN_FILE_DIRS += pkg
 
+pkg_PRIVATE_FCN_FILES = \
+  pkg/private/get_forge_pkg.m
+
 pkg_FCN_FILES = \
   pkg/pkg.m \
-  pkg/get_forge_pkg.m
+  $(pkg_PRIVATE_FCN_FILES)
 
 FCN_FILES += $(pkg_FCN_FILES)
 
--- a/scripts/pkg/pkg.m
+++ b/scripts/pkg/pkg.m
@@ -58,6 +58,10 @@
 ## @item -global
 ## A global installation is forced, even if the user doesn't normally have
 ## system privileges
+## 
+## @item -forge
+## Install a package directly from the Octave-Forge repository.  This
+## requires an internet connection and the cURL library.
 ##
 ## @item -verbose
 ## The package manager will print the output of all of the commands that are
@@ -118,6 +122,9 @@
 ## splits the list of installed packages into those who are installed by
 ## the current user, and those installed by the system administrator.
 ##
+## The option '-forge' lists packages available at the Octave-Forge repository.
+## This requires an internet connection and the cURL library.
+##
 ## @item describe
 ## Show a short description of the named installed packages, with the option
 ## '-verbose' also list functions provided by the package, e.g.:
rename from scripts/pkg/get_forge_pkg.m
rename to scripts/pkg/private/get_forge_pkg.m