Skip to content

Add graphviz extension #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeevantelukula merged 2 commits into from
Apr 22, 2026
Merged

Add graphviz extension #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6d0ef4
conf: include grahviz extension
sadik-smd Apr 14, 2026
09c96b0
fix(buildroot): add architecture for buildroot
sadik-smd Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .rstcheck.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[rstcheck]
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab,graphviz
# ignore the following languages because they require external compilers and
# snippets in this repo depend on external code
ignore_languages = c,cpp,c++
Expand Down
4 changes: 4 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
'sphinx_rtd_theme',
'sphinx_tabs.tabs',
'sphinx_copybutton'
Expand Down Expand Up @@ -253,6 +254,9 @@
# Suppress warnings about excluded documents because every device gets a different toc tree
suppress_warnings = ['toc.excluded']

# Render graphviz diagrams as SVG so that hyperlinks in diagrams are clickable
graphviz_output_format = 'svg'

# -- Tag file loader ------------------------------------------------------

FAMILY = os.environ.get("DEVFAMILY", "")
Expand Down
1 change: 1 addition & 0 deletions docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ RUN apk add --no-cache \
diffutils \
dumb-init \
git \
graphviz \
make \
py3-pip \
ripgrep \
Expand Down
43 changes: 42 additions & 1 deletion source/buildroot/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,48 @@
Buildroot is highly customizable, allowing developers to tailor their Linux
environment to meet the specific needs of their embedded projects.

Buildroot official Git repository is hosted at `Gitlab/Buildroot <https://gitlab.com/buildroot.org/buildroot/>`__.

**************************************
Buildroot Architecture for TI Devices

Check warning on line 13 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Buildroot Architecture for TI Devices'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Buildroot Architecture for TI Devices'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 13, "column": 1}}}, "severity": "INFO"}
**************************************

The diagram below shows the Buildroot-based Linux embedded software distribution main components for TI devices.

Check warning on line 16 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 16, "column": 13}}}, "severity": "INFO"}

The open-source Linux\ :sup:`®` distribution, based on the Buildroot build system, running on the Arm\ :sup:`®` Cortex\ :sup:`®`\-A processors, includes:

Check warning on line 18 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Hyphens] Use 'open source' rather than 'open-source'.

Raw Output:
{"message": "[RedHat.Hyphens] Use 'open source' rather than 'open-source'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 18, "column": 5}}}, "severity": "WARNING"}

- **TI BSP Components** — the Texas Instruments Board Support Package, comprising:

Check warning on line 20 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.EmDash] Do not use em dashes. Use punctuation marks such as commas, parentheses, or colons instead.

Raw Output:
{"message": "[RedHat.EmDash] Do not use em dashes. Use punctuation marks such as commas, parentheses, or colons instead.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 20, "column": 25}}}, "severity": "WARNING"}

Check warning on line 20 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'BSP') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'BSP') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 20, "column": 8}}}, "severity": "INFO"}

- The boot chain based on **TF-A** (Trusted Firmware-A) and **U-Boot**.
- The secure monitor based on **TF-A** and **OP-TEE**, running on the Arm\ :sup:`®`
Cortex\ :sup:`®`\-A in secure mode.
- The **OP-TEE** secure OS running on the Arm\ :sup:`®` Cortex\ :sup:`®`\-A in secure mode,

Check warning on line 25 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 25, "column": 27}}}, "severity": "WARNING"}
providing a Trusted Execution Environment (TEE) for Trusted Applications.

Check warning on line 26 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'TEE') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'TEE') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 26, "column": 48}}}, "severity": "INFO"}
- The **Linux Kernel** and **TI Kernel Drivers** running on the Arm\ :sup:`®`

Check warning on line 27 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 27, "column": 35}}}, "severity": "WARNING"}

Check warning on line 27 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 27, "column": 17}}}, "severity": "WARNING"}
Cortex\ :sup:`®`\-A in non-secure mode, along with board-specific **Device Trees**.

Check failure on line 28 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'insecure' rather than 'non-secure'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'insecure' rather than 'non-secure'.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 28, "column": 28}}}, "severity": "ERROR"}
- The **TI Linux Firmware** providing co-processor firmwares
(not applicable for AM62Lx-EVM).

Check warning on line 30 in source/buildroot/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'EVM') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'EVM') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/buildroot/Overview.rst", "range": {"start": {"line": 30, "column": 32}}}, "severity": "INFO"}

- **Buildroot Build System** — consisting of:

- **Buildroot Core**: the upstream Buildroot framework that drives the entire build.
- **Buildroot External-TI**: the TI-specific external tree
(`buildroot-external-TI <https://github.com/TexasInstruments/buildroot-external-TI>`__)
that adds TI board configurations, packages, and patches without modifying upstream Buildroot.

- **Applications** — the user-space software layer built on top of the BSP, including
GUI applications, custom applications, Trusted Applications running under OP-TEE,
and middleware and libraries.

- **Build Artifacts** — the outputs produced by the Buildroot build system: an SD card
image, individual boot artifacts, and a root filesystem.

.. note::

Each component in the diagram below is a **clickable hyperlink** that navigates
directly to the corresponding source repository or documentation.

.. graphviz:: ../graphviz/Buildroot_architecture.gv
:caption: Buildroot-based Linux Architecture for TI Devices

*************************
Key Features of Buildroot
Expand Down
Loading
Loading