jedfuns.txt.gz needs unzipping

[G. Milde]

On 30.09.05, Paul Boekholt wrote:
> On Fri, 30 Sep 2005 08:42:36 +0200, "G. Milde" <g.milde at web.de> said:
> > On 29.09.05, Jörg Sommer wrote:
> 
> > > We should talk to John if he plans to drop support for Jed_Doc_Files,
> > > because get_doc_files() exists and it is supported by
> > > get_doc_string_from_file(). I would prefer dropping support for
> > > Jed_Doc_Files.
> 
> > Unfortunately, both get_doc_files() and set_doc_files() are
> > undocumented
> 
> get_doc_files(), set_doc_files(), add_doc_file()
> get_doc_string_from_file() and _slang_doc_dir are all documented here (in
> /usr/local/share/doc/slang/v2/slangfun.txt)

You are right. After manually unzipping slangfun.txt.gz, I see the
documentation here as well.

> BTW JED includes the slang doc_files setting in Jed_Doc_Files at
> startup. In site.sl:
> 
> #ifexists _slang_doc_dir
> if (strlen(_slang_doc_dir) > 0)
>   $1 = _slang_doc_dir;
> 
> ...
> 
> Jed_Doc_Files = strcat (Jed_Doc_Files, ",",
> 			path_concat ($1, "slangfun.txt"));


Yes, up to now, help.sl relies on Jed_Doc_Files (and adds the slangfun.txt
location for this means).

As long as this is the case, I will not add a add_doc_file() clause to
add|append_libdir in jedmodes.sf.net/mode/libdir/ .


OTHOH, using the *_doc_files() functions will speed up and facilitate the
help_for_* functions:

   % get doc string
   foreach (strchop(Jed_Doc_Files, ',', 0))
     {
	file = ();
	doc_str = get_doc_string_from_file (file, obj);
	if (doc_str != NULL)
	  break;
     }

becomes simply

   doc_str = get_doc_string_from_file (file);

So I suppose John will do this switch. (My Jedmodes modes will follow,
but I will have to think about backwards compatibility.)

 
> > However, /usr/share/doc/libslang2/slangfun.txt.gz is gzipped, so I'll
> > file a bug report there.
> That's bad, it won't work in slsh either.

Jörg already reported this bug, so I suppose this will be fixed soon.

Guenter


-- 
G.Milde web.de