# HG changeset patch
# User Rik <rik@octave.org>
# Date 1372621896 25200
# Node ID 5372068bb148165d1f5fe5ea898df71e310aa5e7
# Parent  5e30b1c950b8d0b7cf9710b42f24996cc3f9c7fc
Rename gen_doc_cache() to doc_cache_create().

* scripts/help/doc_cache_create.m: Renamed from gen_doc_cache.m

* scripts/help/gen_doc_cache.m: deleted.

* scripts/help/module.mk: Add doc_cache_create to build system.

* scripts/deprecated/module.mk: Add gen_doc_cache to deprecated
directory.

* NEWS: Add note about deprecated function gen_doc_cache and new
function doc_cache_create.

* doc/interpreter/basics.txi: Add doc_cache_create to manual.

* libgui/src/resource-manager.cc: Update list of keywords to
include doc_cache_create.

* libinterp/interpfcn/help.cc: Add seealso links to doc_cache_create.

* scripts/pkg/private/generate_lookfor_cache.m: Change function
calls to doc_cache_create.

diff --git a/NEWS b/NEWS
--- a/NEWS
+++ b/NEWS
@@ -176,19 +176,20 @@
 
  ** Other new functions added in 3.8.0:
 
-      base64_decode               erfcinv        rgbplot                    
-      base64_encode               erfi           shrinkfaces                
-      betaincinv                  expint         splinefit               
-      built_in_docstrings_file    findfigs       strjoin                 
-      cmpermute                   fminsearch     struct2hdl              
-      cmunique                    gallery        tetramesh               
-      colorcube                   gco            waterfall               
-      copyobj                     hdl2struct                  
-      dawson                      importdata                  
-      dblist                      iscolormap  
+      base64_decode               ellipke         polyeig              
+      base64_encode               erfcinv         rgbplot                   
+      betaincinv                  erfi            shrinkfaces            
+      built_in_docstrings_file    expint          splinefit              
+      cmpermute                   findfigs        strjoin                
+      cmunique                    fminsearch      struct2hdl             
+      colorcube                   gallery         tetramesh              
+      copyobj                     gco             waterfall              
+      dawson                      hdl2struct                  
+      dblist                      importdata  
+      doc_cache_create            iscolormap
       ellipj                      lines   
-      ellipke                     polyeig 
-                               
+                           
+
  ** Deprecated functions.
 
     The following functions were deprecated in Octave 3.4 and have been
@@ -204,6 +205,7 @@
     be removed from Octave 3.12 (or whatever version is the second major
     release after 3.8):
 
+      gen_doc_cache
       java_convert_matrix
       java_debug
       java_get
diff --git a/doc/interpreter/basics.txi b/doc/interpreter/basics.txi
--- a/doc/interpreter/basics.txi
+++ b/doc/interpreter/basics.txi
@@ -441,7 +441,7 @@
 generating the documentation.  They are documented here for completeness
 and because they may occasionally be useful for users.
 
-@DOCSTRING(gen_doc_cache)
+@DOCSTRING(doc_cache_create)
 
 @DOCSTRING(get_help_text)
 
diff --git a/libgui/src/resource-manager.cc b/libgui/src/resource-manager.cc
--- a/libgui/src/resource-manager.cc
+++ b/libgui/src/resource-manager.cc
@@ -695,6 +695,7 @@
       "do_braindead_shortcircuit_evaluation "
       "do_string_escapes "
       "doc "
+      "doc_cache_create "
       "doc_cache_file "
       "dos "
       "dot "
@@ -865,7 +866,6 @@
       "gcd "
       "gcf "
       "ge "
-      "gen_doc_cache "
       "genpath "
       "genvarname "
       "geocdf "
diff --git a/libinterp/interpfcn/help.cc b/libinterp/interpfcn/help.cc
--- a/libinterp/interpfcn/help.cc
+++ b/libinterp/interpfcn/help.cc
@@ -1401,7 +1401,7 @@
 When called from inside a function with the \"local\" option, the variable is\n\
 changed locally for the function and any subroutines it calls.  The original\n\
 variable value is restored when exiting the function.\n\
-@seealso{lookfor, info_program, doc, help, makeinfo_program}\n\
+@seealso{doc_cache_create, lookfor, info_program, doc, help, makeinfo_program}\n\
 @end deftypefn")
 {
   return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file);
diff --git a/scripts/deprecated/module.mk b/scripts/deprecated/module.mk
--- a/scripts/deprecated/module.mk
+++ b/scripts/deprecated/module.mk
@@ -7,6 +7,7 @@
   deprecated/cut.m \
   deprecated/java_debug.m \
   deprecated/error_text.m \
+  deprecated/gen_doc_cache.m \
   deprecated/isstr.m \
   deprecated/java_convert_matrix.m \
   deprecated/java_get.m \
diff --git a/scripts/help/gen_doc_cache.m b/scripts/help/doc_cache_create.m
rename from scripts/help/gen_doc_cache.m
rename to scripts/help/doc_cache_create.m
--- a/scripts/help/gen_doc_cache.m
+++ b/scripts/help/doc_cache_create.m
@@ -17,7 +17,7 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} gen_doc_cache (@var{out_file}, @var{directory})
+## @deftypefn {Function File} {} doc_cache_create (@var{out_file}, @var{directory})
 ## Generate documentation caches for all functions in a given directory.
 ##
 ## A documentation cache is generated for all functions in @var{directory}.
@@ -28,10 +28,10 @@
 ## If no directory is given (or it is the empty matrix), a cache for builtin
 ## operators, etc. is generated.
 ##
-## @seealso{lookfor, path}
+## @seealso{doc_cache_file, lookfor, path}
 ## @end deftypefn
 
-function gen_doc_cache (out_file = "doc-cache", directory = [])
+function doc_cache_create (out_file = "doc-cache", directory = [])
 
   ## Check input
   if (! ischar (out_file))
@@ -45,12 +45,12 @@
     if (all (cellfun (@ischar, directory)))
       cache = gen_doc_cache_in_dir (directory);
     else
-      error ("gen_doc_cache: cell must contain only strings");
+      error ("doc_cache_create: cell must contain only strings");
     endif
   elseif (ischar (directory))
      cache = gen_doc_cache_in_dir (directory);
   else
-     error ("gen_doc_cache: second input argument must be a string or a cell of strings");
+     error ("doc_cache_create: second input argument must be a string or a cell of strings");
   endif
 
   ## Save cache
@@ -82,7 +82,7 @@
 
   ## Did we get the help text?
   if (status != 0 || isempty (text))
-    warning ("gen_doc_cache: unusable help text found in file '%s'", f);
+    warning ("doc_cache_create: unusable help text found in file '%s'", f);
     return;
   endif
 
@@ -156,4 +156,4 @@
 
 %% No true tests desirable for this function.
 %% Test input validation
-%!error gen_doc_cache (1)
+%!error doc_cache_create (1)
diff --git a/scripts/help/module.mk b/scripts/help/module.mk
--- a/scripts/help/module.mk
+++ b/scripts/help/module.mk
@@ -8,7 +8,7 @@
   help/__makeinfo__.m \
   help/__unimplemented__.m \
   help/doc.m \
-  help/gen_doc_cache.m \
+  help/doc_cache_create.m \
   help/get_first_help_sentence.m \
   help/help.m \
   help/lookfor.m \
diff --git a/scripts/pkg/private/generate_lookfor_cache.m b/scripts/pkg/private/generate_lookfor_cache.m
--- a/scripts/pkg/private/generate_lookfor_cache.m
+++ b/scripts/pkg/private/generate_lookfor_cache.m
@@ -25,7 +25,7 @@
 function generate_lookfor_cache (desc)
   dirs = strtrim (ostrsplit (genpath (desc.dir), pathsep ()));
   for i = 1 : length (dirs)
-    gen_doc_cache (fullfile (dirs{i}, "doc-cache"), dirs{i});
+    doc_cache_create (fullfile (dirs{i}, "doc-cache"), dirs{i});
   endfor
 endfunction