Directories

A core directory is an entity that provides access to core description files. Currently the only supported directory type is path-based. The following summarizes how to generalize it.

CoreDirectory class

A core directory implements some basic functions:

• allowsListing: Returns if all cores in the directory can be listed at once
• listCores: Returns a list of cores
• searchCore: Search for a core pattern
• getCore: Returns a core description file for a core

File-based Directory

This is the standard directory currently used. It allows listing and indexes all local core files.

librecores Directory

This is the new api.librecores.org adapter. It does not allow listing of cores, but it can be searched. It maps vendor to a user or project (which share the namespace as in Github), library to a LibreCore (which is like a repository and core to the core file name in the addressed LibreCore repository.

Configuration

The configuration file contains a list of directories as core_root that contains items with an optional comma separated parameter list:

cores_root = filesystem,/path/to/orpsoc-cores librecores