Skip to content

Commit

Permalink
doc: use graphviz for intro boot-flow diagram
Browse files Browse the repository at this point in the history
Trying out the graphviz capability rather than using static images that
we can't easily modify.  Also updated the site logo that was too wide.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
  • Loading branch information
dbkinder committed Jun 11, 2018
1 parent 64515cf commit 44293a4
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 6 deletions.
8 changes: 6 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@
# ones.
extensions = ['breathe', 'sphinx.ext.graphviz']

graphviz_output_format='svg'
graphviz_output_format='png'
graphviz_dot_args=[
'-Nfontname="verdana"',
'-Gfontname="verdana"',
'-Efontname="verdana"']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -174,7 +178,7 @@
#
# html_theme_options = {}

html_logo = 'images/ACRN_Logo_300w.png'
html_logo = 'images/ACRN_Logo_200w.png'
html_favicon = 'images/ACRN-favicon-32x32.png'

numfig = True
Expand Down
Binary file added doc/images/ACRN_Logo_200w.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions doc/introduction/images/boot-flow.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
digraph G {
rankdir=LR;
bgcolor="transparent";
UEFI -> "acrn.efi" -> "OS\nBootloader" ->
"SOS\nKernel" -> "ACRN\nDevice Model" -> "Virtual\nBootloader";
}
7 changes: 3 additions & 4 deletions doc/introduction/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,10 @@ Boot Sequence
In :numref:`boot-flow` we show a verified Boot Sequence with UEFI
on an Intel |reg| Architecture platform NUC (see :ref:`hardware`).

.. figure:: images/boot-flow.png
:align: center
.. graphviz:: images/boot-flow.dot
:name: boot-flow

ACRN Hypervisor Boot Flow
:align: center
:caption: ACRN Hypervisor Boot Flow

The Boot process proceeds as follows:

Expand Down

0 comments on commit 44293a4

Please sign in to comment.