<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2018-07-01 Sun 20:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Yet another Erlang Make implementation</title>
<meta name="generator" content="Org-mode" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2013 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">Yet another Erlang Make implementation</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgheadline1">1. <span class="todo TODO">TODO</span> Description</a></li>
<li><a href="#orgheadline6">2. Features</a>
<ul>
<li><a href="#orgheadline2">2.1. Dynamic tasks</a></li>
<li><a href="#orgheadline3">2.2. Painstakingly tested</a></li>
<li><a href="#orgheadline5">2.3. Written with build flow optimization in mind</a>
<ul>
<li><a href="#orgheadline4">2.3.1. Dependency graph visualization</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgheadline7">3. Examples</a></li>
</ul>
</div>
</div>
<p>
<a href="https://travis-ci.org/k32/task_graph.svg?branch=master">https://travis-ci.org/k32/task_graph.svg?branch=master</a>
</p>
<div id="outline-container-orgheadline1" class="outline-2">
<h2 id="orgheadline1"><span class="section-number-2">1</span> <span class="todo TODO">TODO</span> Description</h2>
<div class="outline-text-2" id="text-1">
<p>
Yet another library reinventing good old <code>make</code>, implemented in pure
Erlang. This library aims to do one thing right: it runs tasks in
parallel in topological order. Hence it doesn't do globing,
templating, it doesn't provide any DSLs, etc…
</p>
</div>
</div>
<div id="outline-container-orgheadline6" class="outline-2">
<h2 id="orgheadline6"><span class="section-number-2">2</span> Features</h2>
<div class="outline-text-2" id="text-2">
</div><div id="outline-container-orgheadline2" class="outline-3">
<h3 id="orgheadline2"><span class="section-number-3">2.1</span> Dynamic tasks</h3>
<div class="outline-text-3" id="text-2-1">
<p>
Tasks may spawn other tasks or discover their own dependencies
dynamically
</p>
</div>
</div>
<div id="outline-container-orgheadline3" class="outline-3">
<h3 id="orgheadline3"><span class="section-number-3">2.2</span> Painstakingly tested</h3>
<div class="outline-text-3" id="text-2-2">
<p>
Random task graph topologies are tested using <a href="http://proper.softlab.ntua.gr/">proper</a>.
</p>
<p>
Absence of race conditions is exhaustively <sup><a id="fnr.1" class="footref" href="#fn.1">1</a></sup> verified using <a href="https://concuerror.com/">concuerror</a>.
</p>
</div>
</div>
<div id="outline-container-orgheadline5" class="outline-3">
<h3 id="orgheadline5"><span class="section-number-3">2.3</span> Written with build flow optimization in mind</h3>
<div class="outline-text-3" id="text-2-3">
</div><div id="outline-container-orgheadline4" class="outline-4">
<h4 id="orgheadline4"><span class="section-number-4">2.3.1</span> Dependency graph visualization</h4>
</div>
</div>
</div>
<div id="outline-container-orgheadline7" class="outline-2">
<h2 id="orgheadline7"><span class="section-number-2">3</span> Examples</h2>
<div class="outline-text-2" id="text-3">
<p>
Basic usage:
</p>
<div class="org-src-container">
<pre class="src src-erlang">-include_lib("task_graph/include/task_graph.hrl").
main() ->
%% Define tasks:
Tasks = [#task{ task_id = I
, execute = fun(MyId, MyData) ->
io:format("I'm ~p, doing ~p~n", [MyId, MyData])
end,
, data = something
}
|| I <- lists:seq(1, 4)],
%% Define dependnecies ({A, B} reads as "B depends on A"):
Edges = [{1, 2}, {1, 3}, {2, 3}, {2, 4}],
%% Execute graph:
{ok, _} = task_graph:run_graph(my_graph, {Tasks, Edges}).
</pre>
</div>
<p>
Got lost in the dependencies? It's possible to visualize the graph:
</p>
<div class="org-src-container">
<pre class="src src-erlang">Opts = #{event_handlers =>
[{task_graph_draw_deps, #{ filename => "dependencies.dot"
%% You can optionally customize shape and color of vertices:
, color => fun(#task{}) ->
green
end
, shape => fun(#task{}) ->
oval
end
}}]},
{ok, _} = task_graph:run_graph(my_graph, Opts, {Tasks, Edges}).
</pre>
</div>
<p>
Render the resulting file using graphviz:
</p>
<div class="org-src-container">
<pre class="src src-bash">dot -Tpng -O dependencies.dot
</pre>
</div>
</div>
</div>
<div id="footnotes">
<h2 class="footnotes">Footnotes: </h2>
<div id="text-footnotes">
<div class="footdef"><sup><a id="fn.1" class="footnum" href="#fnr.1">1</a></sup> <div class="footpara"><p class="footpara">
Concuerror tests all possible schedulings of a single test graph
</p></div></div>
</div>
</div></div>
<div id="postamble" class="status">
<p class="date">Created: 2018-07-01 Sun 20:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>
