This repository was archived by the owner on Jan 27, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdefinition.html
363 lines (269 loc) · 18.2 KB
/
definition.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8">
<!-- seems to be needed -->
<meta http-equiv="Content-Security-Policy" content="default-src *; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' 'unsafe-eval'">
<title>💄 Definition isolator – De Re mulle-sde</title>
<meta name="description" content="The mulle-sde virtual environment shields the project from
unintentional environment settings. But that is not enough separation, if the
project is made up of multiple projects (a.k.a. “dependencies”).
">
<meta name="keywords" content="">
<!-- Twitter Cards -->
<meta name="twitter:title" content="💄 Definition isolator">
<meta name="twitter:description" content="The mulle-sde virtual environment shields the project from unintentional environment settings. But that is not enough separation, if the project is made up of multiple projects (a.k.a. “dependencies”). Here is a contrived example. The main project get its current version via the commandline like cc -DVERSION='"1"'. Lets use the mulle-sde...">
<meta name="twitter:site" content="@mulle_nat">
<meta name="twitter:creator" content="@mulle_nat">
<meta name="twitter:card" content="summary">
<meta name="twitter:image" content="https://www.mulle-kybernetik.com/de-re-mulle-sde/images/default-thumb.png">
<!-- Open Graph -->
<meta property="og:locale" content="en_US">
<meta property="og:type" content="article">
<meta property="og:title" content="💄 Definition isolator">
<meta property="og:description" content="The mulle-sde virtual environment shields the project from unintentional environment settings. But that is not enough separation, if the project is made up of multiple projects (a.k.a. “dependencies”). Here is a contrived example. The main project get its current version via the commandline like cc -DVERSION='"1"'. Lets use the mulle-sde...">
<meta property="og:url" content="https://www.mulle-kybernetik.com/definition.html">
<meta property="og:site_name" content="De Re mulle-sde">
<meta property="og:image" content="https://www.mulle-kybernetik.com/de-re-mulle-sde/images/default-thumb.png">
<meta property="og:logo" content="https://www.mulle-kybernetik.com/de-re-mulle-sde/images/logo.png">
<link href="/de-re-mulle-sde/atom.xml" type="application/atom+xml" rel="alternate" title="De Re mulle-sde Feed">
<link href="/de-re-mulle-sde/index.rdf" type="application/rss+xml" rel="alternate" title="De Re mulle-sde Feed">
<link rel="canonical" href="https://www.mulle-kybernetik.com/definition.html">
<!-- Mobile Specific Metas
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- CSS
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/skeleton.css">
<!-- Code Color
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
<link rel="stylesheet" href="css/monokai.css">
<!-- Site custom css -->
<link rel="stylesheet" href="css/custom.css">
<!-- local FONT
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
<link rel="stylesheet" href="css/junction.css">
<!-- Favicon
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
<link rel="icon" type="image/svg" href="images/favicon.svg">
<!-- This tag allows for activation of ClearType in Mobile IE for smoothing fonts.-->
<meta http-equiv="cleartype" content="on">
<!-- http://t.co/dKP3o1e -->
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- For all browsers -->
</head>
<body class="post">
<div class="container">
<div class="row">
<div id="post-first" class="four columns">
<div class="sideline">
<div class="bio">
<div class="bio-photo-container" style="display: inline-block">
<img src="images/dog-pic.jpg" class="bio-photo" alt="Nat! bio photo">
</div>
<div style="display: inline-block; padding-left: 8px">
<h4>Nat!</h4>
<p>Senior Mull</p>
</div>
<div class="author-social"><a href="//www.mulle-kybernetik.com" target="_blank" class="link"><img class="inline-img" src="images/homepage-svgrepo-com.svg"></a> <a href="//www.mulle-kybernetik.com" target="_blank" class="link">WWW</a></div>
<div class="author-social"><a href="mailto:[email protected]" target="_blank"><img class="inline-img" src="images/email-svgrepo-com.svg"></a> <a href="mailto:[email protected]" target="_blank" class="link">Email</a></div>
<div class="author-social"><a href="//twitter.com/mulle_nat" target="_blank"><img class="inline-img" src="images/twitter-svgrepo-com.svg"></a> <a href="//twitter.com/mulle_nat" target="_blank" class="link">Twitter</a></div>
<div class="author-social"><a href="//github.com/mulle-nat" target="_blank"><img class="inline-img" src="images/github-svgrepo-com.svg"></a> <a href="//github.com/mulle-nat" target="_blank" class="link">Github</a></div>
<div class="author-social"><a href="//twitch.tv/Mulle_kybernetiK_TV" target="_blank"><img class="inline-img" src="images/twitch-svgrepo-com.svg"></a> <a href="//twitch.tv/Mulle_kybernetiK_TV" target="_blank" class="link">Twitch</a></div>
</div> <!-- bio -->
<div class="title">
<div>
<h2>De Re mulle-sde <div style="font-size:10px; display: inline-block;">1.1.0</div> <a href="feed.xml"><img class="inline-img" src="/de-re-mulle-sde/images/feed-icon-28x28.png"></a></h2>
<h7></h7>
</div>
<h6>© 2022-2024 by Nat!, Mulle kybernetiK. All rights reserved.</h6>
<p>
</div> <!-- title -->
<div class="contents">
<h4>Contents</h4>
<ul>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/intro.html" title="Intro">Intro</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/existing-makefile.html" title="🔶 Manage a Makefile project 🆕">🔶 Manage a Makefile project 🆕</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/virtual-env.html" title="🌳 Virtual Environment">🌳 Virtual Environment</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/template.html" title="🕋 Template generator">🕋 Template generator</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/compositor.html" title="🌲 Project Compositor">🌲 Project Compositor</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/builder.html" title="🚬 Fetch and build">🚬 Fetch and build</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/makefile.html" title="💠 Makefile maintainer">💠 Makefile maintainer</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/test-coverage.html" title="☑︎ Test suite with Coverage 🆕">☑︎ Test suite with Coverage 🆕</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/definition.html" title="💄 Definition isolator">💄 Definition isolator</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/outro.html" title="Outro">Outro</a>
</article>
<article>
<li class="no-bullet"><a class="internal-link" href="/de-re-mulle-sde/hecklers-corner.html" title="Hecklers Corner">Hecklers Corner</a>
</article>
</ul>
<h5> Or read it like a <a href="book.html"><b>book</b></a>.</h6>
</div> <!-- contents -->
</div> <!-- sideline -->
</div>
<div id="post-second" class="eight columns">
<div class="title">
<div>
<h2>De Re mulle-sde <div style="font-size:10px; display: inline-block;">1.1.0</div> <a href="feed.xml"><img class="inline-img" src="/de-re-mulle-sde/images/feed-icon-28x28.png"></a></h2>
<h7></h7>
</div>
<h6>© 2022-2024 by Nat!, Mulle kybernetiK. All rights reserved.</h6>
<p>
</div> <!-- title -->
<p>
<div id="main" role="main">
<article>
<h1>💄 Definition isolator</h1>
<div>
<p>The mulle-sde <a href="virtual_env.html">virtual environment</a> shields the project from
unintentional environment settings. But that is not enough separation, if the
project is made up of multiple projects (a.k.a. “dependencies”).</p>
<p>Here is a contrived example. The main project get its current version via the
commandline like <code class="language-plaintext highlighter-rouge">cc -DVERSION='"1"'</code>. Lets use the mulle-sde environment to
set <code class="language-plaintext highlighter-rouge">CFLAGS</code>, assuming that this is picked up by the Makefile.</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>mulle-sde environment <span class="nb">set </span>CFLAGS <span class="s1">'-DVERSION="1"'</span>
</code></pre></div></div>
<p>It will work fine, until you add a third-party dependency, which also uses a
<code class="language-plaintext highlighter-rouge">VERSION</code> definition. As the mulle-sde environment is active during the build
of the project and the build of the dependency, there will be a clash.</p>
<h2 id="definitions-environments-for-a-build">Definitions: environments for a build</h2>
<p><em>mulle-make</em> is the meta-builder, that uses build systems like <em>cmake</em> and
<em>autoconf</em> and <em>xcodebuild</em>, to build a dependency or the project itself.
That may sound fancy, but is really not much more than what this little script
does:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">#! /bin/sh</span>
<span class="k">if</span> <span class="o">[</span> <span class="nt">-f</span> CMakeLists.txt <span class="o">]</span>
<span class="k">then
</span>cmake <span class="nt">-B</span> build <span class="nt">-S</span> <span class="nb">.</span>
cmake <span class="nt">--build</span> build
<span class="k">else</span>
<span class="c"># use some other build tool</span>
<span class="k">fi</span>
</code></pre></div></div>
<p>One thing <em>mulle-make</em> adds to the process, is that it looks at variables that
start with the string ‘DEFINITION_’ and uses those to create options for
the individual build tool (unknown options are passed verbatim).</p>
<p>For example the value of <code class="language-plaintext highlighter-rouge">DEFINITION_CFLAGS='-DVERSION="1"'</code> will be used
by the <em>cmake</em> plugin of mulle-make to produce a
<code class="language-plaintext highlighter-rouge">-DCMAKE_C_FLAGS='-DVERSION="1"'</code> command line option for cmake.</p>
<p>So how are <code class="language-plaintext highlighter-rouge">DEFINITION_</code> variables set in mulle-make ? They are fed to
mulle-make by another tool mulle-craft. mulle-craft searches for applicable
definition folders and applies them to the mulle-make call. There can be
multiple definitions, which enables inheritance schemes.</p>
<h2 id="project-definitions">Project definitions</h2>
<p>The main project <code class="language-plaintext highlighter-rouge">definition</code> folder is managed with the <code class="language-plaintext highlighter-rouge">mulle-sde definition</code>
commands. The values contained in it are only used for the main project and can
not be overridden.</p>
<p><img src="images/definition1.svg" alt="Project definitions" /></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">cd </span>foo
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"1"'</span> ...
</code></pre></div></div>
<h2 id="dependency-definitions">Dependency definitions</h2>
<p>A dependency definition is just a project definition from a different
perspective. Here a third party project may very well also have a <code class="language-plaintext highlighter-rouge">definition</code>
folder, if it is a mulle-sde project. This definition will be used during
its build. But it will not interfere with the main project craft.</p>
<p><img src="images/definition2.svg" alt="Dependency definitions" /></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">(</span>
<span class="nb">cd </span>foo/stash/bar
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"2"'</span> ...
<span class="o">)</span>
<span class="nb">cd </span>foo
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"1"'</span> ...
</code></pre></div></div>
<h2 id="project-craftinfos">Project craftinfos</h2>
<p>The project has the option to override dependency definitions with <code class="language-plaintext highlighter-rouge">craftinfos</code>.
This is especially useful for third party projects, that are not mulle-sde
projects. With a <em>craftinfo</em> you can tweak the build process of that dependency
to your liking without having to edit the dependency source itself.</p>
<p><img src="images/definition3.svg" alt="Project craftinfos" /></p>
<p>The values in the <em>craftinfo</em> will usually override the values in the
<em>definition</em> of the dependency. So <code class="language-plaintext highlighter-rouge">-DVERSION="3"</code> will be in effect for
the craft of “bar”.</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">(</span>
<span class="nb">cd </span>foo/stash/bar
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"3"'</span> ...
<span class="o">)</span>
<span class="nb">cd </span>foo
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"1"'</span> ...
</code></pre></div></div>
<h2 id="inherited-definitions">Inherited definitions</h2>
<p>Maybe the most powerful feature of the mulle-sde build system are inherited
<em>definitions</em>. These definitions are installed by dependencies into the
<code class="language-plaintext highlighter-rouge">dependency/share</code> folder and can affect all consecutive dependencies.
This for example allows the switch of compilers during the craft of
dependencies.</p>
<p>Multiple dependencies can add and subtract from these definitions.</p>
<p><img src="images/definition4.svg" alt="Inherited craftinfos" /></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">(</span>
<span class="nb">cd </span>foo/stash/bar
cc <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"3"'</span> ...
<span class="o">)</span>
<span class="nb">cd </span>foo
mulle-clang <span class="nt">-DVERSION</span><span class="o">=</span><span class="s1">'"1"'</span> ...
</code></pre></div></div>
<p>Inherited definitions can augment the <em>definitions</em> of the main project, but
it can not override them.</p>
<p>Inherited definitions can override the <em>definitions</em> of dependencies, but
it does not override <em>craftinfos</em>.</p>
</div>
</article>
</div>
<p>
<div class="left-right" id="pn-container">
<div class="left-half">
<span class="link">
Back to <a rel="prev" class="internal-link" href="/de-re-mulle-sde/test-coverage.html">☑︎ Test suite with Coverage 🆕</a>
</span>
</div>
<div class="right-half">
<span class="link">
Next <a rel="next" class="internal-link" href="/de-re-mulle-sde/outro.html">Outro</a>
</span>
</div>
</div> <!-- left_right -->
</div> <!-- eight columns -->
</div> <!-- row -->
</div> <!-- container -->
<!-- Matomo -->
<script type="text/javascript">
var _paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["setCookieDomain", "*.www.mulle-kybernetik.com"]);
_paq.push(["setDomains", ["*.www.mulle-kybernetik.com"]]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//www.mulle-kybernetik.com/matomo/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '1']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<noscript><p><img src="//www.mulle-kybernetik.com/matomo/matomo.php?idsite=1&rec=1" style="border:0;" alt="" /></p></noscript>
<!-- End Matomo Code -->
</body>
</html>