orbit tree

NAME

tree - show a dependency graph

SYNOPSIS

orbit tree [options] [<unit>...]

DESCRIPTION

Shows the hierarchical tree structure of the hardware design starting from a root node.

By default, it will try to automatically detect the root node for the local project. If there is ambiguity in determining what node can be the root, then all root nodes and their respective trees will be displayed. To only display the tree of a particular node, use the <unit> option.

The tree can display different kinds of dependencies relative to the current project using the --edges option. By default, this command uses "unit". By specifying edges as "project", it will return the project-level dependency tree. When using "unit" or "all", the HDL dependency graph will be displayed.

The HDL graph shown with "unit" displays the composition of usable entities/modules. To generate this graph, it analyzes each VHDL architecture and ignores Verilog compiler directives. If an unidentified entity is instantiated, it will appear as a leaf in the graph and will be considered as a "black box" denoted by the "?" character next to its position in the tree. The HDL graph shown with "all" displays the composition of the design including all primary design unit references. Any references (excluding entity instantiations) that are not found will not appear in the dependency graph for the "all" option.

Nodes marked with (*) have been "de-duplicated". The dependencies for the node have already been shown elsewhere in the graph, and so are not repeated. Use the --no-dedupe option to repeat the duplicates.

Using the --format option can alter how much information is displayed for each HDL design unit in the tree composition. By default, only the design unit's name is displayed for each unit.

If the tree's character output is not displaying properly, then the tree can be displayed using a set of standard ASCII characters with the --charset option set to "ascii".

OPTIONS

<unit>...
            Uppermost hdl unit of the dependency tree

--edges, -e <kind>
            The kind of dependencies to display (unit, project, all)

--invert, -i
            Show the reverse dependencies for the node

--depth <depth>
            Maximum display depth of the dependency tree

--format <format>
            Determine how to display node names (short, long)

--no-dedupe
            Do not de-duplicate repeated dependencies

--charset <charset>
            Choose the character set for the tree (utf8, ascii)

--json
            Export the tree's information as valid json

EXAMPLES

orbit tree
orbit tree top --format long
orbit tree -e project --charset ascii