Filesets

A fileset is group of files identified by a common file pattern. Typically they are denoted by a common file extension, such as .txt, but a fileset can more broadly be grouped under any glob-style file pattern.

A fileset itself consists of a name and one or more file patterns.

• The name is a string that is normalized to COBOL-CASE, which uses all upper case letters and the hyphen - delimiter. It is used to identify which fileset a file belongs to.
• A file pattern is a glob-style file pattern. It is used to perform glob-style matching when searching the file system for files to add to a fileset.

If a file in the search space matches a least one of defined file patterns of a fileset, then it will be added under that fileset.

Built-in filesets

There are built-in filesets that Orbit uses that have special rules and work across all ip, including dependencies. The following filesets are currently built-in with Orbit:

• VHDL: VHDL files (.vhd, .vhdl)
• VLOG: Verilog files (.v, .vl, .vlg)
• SYSV: SystemVerilog files (.sv)

Custom filesets

Custom filesets are filesets that are be defined by the user for a specific target. By default, these filesets are only searched for in the local ip and do not extend any of the ip's dependencies. Set the recursive entry of a fileset true to apply it to all ips in the dependency graph.

If a pattern does not start with an explicit path delimiter (/), then Orbit assumes to look for the fileset across every possible subdirectory in the local ip by implicitly prepending the pattern with **/.

A custom fileset's patterns support string swapping. See String Swapping to learn more about how it can be applied to fileset patterns.

Applying fileset patterns

A fileset's pattern is applied starting from the current ip's root directory, the same directory where the Orbit.toml file exists.

Name normalization examples

Despite how the user enters the name of a fileset in a target's configuration, the name will be normalized to COBOL-CASE. The following are some examples of how the normalization process works on a variety of naming conventions.

The normalized fileset name is the name that will be written to the blueprint file when collecting filesets. This design choice is for consistency across targets when reading and parsing the blueprint.

Custom pattern assumption examples

Unless starting with a path delimiter (/), a pattern of a fileset is assumed to be applied across the ip's directory and all of its subdirectories. The following are some examples of how Orbit interprets a fileset's patterns.

The custom patterns begin their search for files at the local ip's root directory. The file pattern used by Orbit when collecting files for custom filesets is the interpreted pattern.