Skip to content

Commit

Permalink
Add dependency figure to libjinue README.md (#98)
Browse files Browse the repository at this point in the history
Add dependency figure to libjinue README.md.
  • Loading branch information
phaubertin authored Dec 3, 2024
1 parent 386f430 commit c0fb66e
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 0 deletions.
36 changes: 36 additions & 0 deletions doc/images/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Copyright (C) 2024 Philippe Aubertin.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the author nor the names of other contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

PNG = libjinue-deps.png

.PHONY: all
all: $(PNG)

%.png: %.gv
dot -Tpng -o $@ $<
29 changes: 29 additions & 0 deletions doc/images/libjinue-deps.gv
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
digraph "libjinue-deps" {
ranksep="1.0";

utils[label="libjinue-utils"];
libc[label="libc"];
libjinue[label="libjinue"];

utils->libc;
utils->libjinue;
libc->libjinue;

{
rank=same;
node[shape="box"];
edge[style="invis"];
jinue_h[label="<jinue/jinue.h>"];
libjinue->jinue_h;
}

{
rank=same;
node[shape="box"];
edge[style="invis"];
utils_h[label="<jinue/utils.h>"];
loader_h[label="<jinue/loader.h>"];
utils->loader_h;
utils->utils_h;
}
}
Binary file added doc/images/libjinue-deps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions userspace/lib/jinue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ Build artifacts:
* `<jinue/logging.h>` contains declarations for logging functions.
* `<jinue/loader.h>` contains declarations for interfacing with the [user
space loader](../../loader/).

![Dependencies](../../../doc/images/libjinue-deps.png)

0 comments on commit c0fb66e

Please sign in to comment.