[Octave-bug-tracker] [bug #57826] pkg: install extracts docstrings from all m-files files recursively

[Mike Miller]

URL:
  <https://savannah.gnu.org/bugs/?57826>

                 Summary: pkg: install extracts docstrings from all m-files
files recursively
                 Project: GNU Octave
            Submitted by: mtmiller
            Submitted on: Sat 15 Feb 2020 01:22:02 PM PST
                Category: Octave Function
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Unexpected Error
                  Status: Confirmed
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: dev
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

When installing a package, the local function 'generate_lookfor_cache' uses
'genpath' to find all subdirectories of a package when extracting docstrings.

A package may contain an 'inst' directory with subdirectories that aren't
added to the load path when the package is actually used, and they should not
be included in the docstring cache.

So ideally, the 'generate_lookfor_cache' will call 'addpath' to determine
which subdirectories are actually going to be added to the path (e.g. with
PKG_ADD).

Examples

* A package may have an 'inst/contrib', 'inst/examples', or 'inst/legacy'
subdirectory with m-files that the maintainer doesn't want added to the load
path by default.
* A package may have an 'inst/octave-7' subdirectory with m-files copied from
a newer version of Octave that should only be loaded conditionally.

See https://github.com/apjanke/octave-testify/issues/95




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?57826>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/