Open
Conversation
Include graphviz extension for generating flow diagrams and add graphviz output format as SVG. Include the graphviz package to Dockerfile Signed-off-by: Mahammed Sadik Shaik <[email protected]>
Add a architecture diagram for buildroot build system using graphviz. Signed-off-by: Mahammed Sadik Shaik <[email protected]>
sadik-smd
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
|
New warnings found with rstcheck: |
Comment on lines
+53
to
+56
| .. graphviz:: | ||
| :caption: Buildroot-based Linux Architecture for TI Devices | ||
|
|
||
| digraph buildroot_architecture { |
Member
There was a problem hiding this comment.
May want to make this an external file considering it's length.
https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html#directive-graphviz
Member
|
Please add the graphviz directives to the following config: processor-sdk-doc/.rstcheck.cfg Line 2 in a8ba562 |
Member
|
Also, you may want to try and restructure that graph a little, since it's very wide and will be dynamically scaled to match the aspect ratio of the screen viewing it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a visual architecture diagram for the Buildroot-based
Linux embedded software stack targeting TI SoCs
Changes
conf.pysphinxcontrib.graphviztoextensionslistgraphviz_output_format = "svg"for crisp scalable outputDockerfilegraphvizpackagesource/buildroot/Overview.rst.. graphviz::directive with full architecture diagramPreview for this architecture diagram can be found at-:
https://sadik-smd.github.io/processor-sdk-doc-fork/processor-sdk-buildroot-AM62X/esd/docs/master/buildroot/Overview.html#buildroot-architecture-for-ti-devices