349 lines
16 KiB
HTML
349 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Common Properties And Functions - Minimal Linux Live</title>
|
|
|
|
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
|
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff" />
|
|
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
|
|
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="highlight.css">
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<!-- Provide site root to javascript -->
|
|
<script type="text/javascript">
|
|
var path_to_root = "";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script type="text/javascript">
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script type="text/javascript">
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('no-js')
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add('js');
|
|
</script>
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script type="text/javascript">
|
|
var html = document.querySelector('html');
|
|
var sidebar = 'hidden';
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
}
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="architecture.html"><strong aria-hidden="true">1.</strong> Architecture</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="boot_process.html"><strong aria-hidden="true">1.1.</strong> Boot Process</a></li><li class="chapter-item expanded "><a href="filesystem_layout.html"><strong aria-hidden="true">1.2.</strong> Filesystem Layout</a></li></ol></li><li class="chapter-item expanded "><a href="overview.html"><strong aria-hidden="true">2.</strong> Initial Workspace</a></li><li class="chapter-item expanded "><a href="build_scripts.html"><strong aria-hidden="true">3.</strong> Build Process</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="common.html" class="active"><strong aria-hidden="true">3.1.</strong> Common Properties And Functions</a></li><li class="chapter-item expanded "><a href="00_clean.html"><strong aria-hidden="true">3.2.</strong> Step 00 - Clean Workspace</a></li><li class="chapter-item expanded "><a href="01_get_kernel.html"><strong aria-hidden="true">3.3.</strong> Step 01 - Get Kernel</a></li><li class="chapter-item expanded "><a href="02_build_kernel.html"><strong aria-hidden="true">3.4.</strong> Step 02 - Build Kernel</a></li></ol></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|
<div class="left-buttons">
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</button>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
|
|
</div>
|
|
|
|
<h1 class="menu-title">Minimal Linux Live</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script type="text/javascript">
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1><a class="header" href="#common-properties-and-functions" id="common-properties-and-functions">Common Properties And Functions</a></h1>
|
|
<ul>
|
|
<li><a href="#properties">Properties</a></li>
|
|
<li><a href="#functions">Functions</a></li>
|
|
</ul>
|
|
<hr />
|
|
<p>The shell script file <a href="https://github.com/ivandavidov/minimal/blob/master/src/common.sh">common.sh</a> is sourced in all MLL scripts. It provides common properties and functions.</p>
|
|
<h2><a class="header" href="#properties" id="properties">Properties</a></h2>
|
|
<h4><a class="header" href="#src_dir" id="src_dir">SRC_DIR</a></h4>
|
|
<p><code>SRC_DIR=src/</code></p>
|
|
<p>This is the main source directory, i.e. the property references the main project directory <code>src/</code>.</p>
|
|
<h4><a class="header" href="#config" id="config">CONFIG</a></h4>
|
|
<p><code>CONFIG=src/.config</code></p>
|
|
<p>This is the main configuration file. The configuration properties are described <a href="TODO...">here</a>. </p>
|
|
<h4><a class="header" href="#source_dir" id="source_dir">SOURCE_DIR</a></h4>
|
|
<p><code>SOURCE_DIR=src/source/</code></p>
|
|
<p>This is the directory where all source archives are downloaded. </p>
|
|
<h4><a class="header" href="#work_dir" id="work_dir">WORK_DIR</a></h4>
|
|
<p><code>WORK_DIR=src/work/</code></p>
|
|
<p>This is the directory where all MLL artifacts are processed. All build actions happen in this directory. </p>
|
|
<h4><a class="header" href="#kernel_installed" id="kernel_installed">KERNEL_INSTALLED</a></h4>
|
|
<p><code>KERNEL_INSTALLED=src/work/kernel/kernel_installed/</code></p>
|
|
<p>This is the directory where the kernel and its corresponding header files are placed after the kernel build phase has been completed. </p>
|
|
<h4><a class="header" href="#glibc_objects" id="glibc_objects">GLIBC_OBJECTS</a></h4>
|
|
<p><code>GLIBC_OBJECTS=src/work/glibc/glibc_objects/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#glibc_installed" id="glibc_installed">GLIBC_INSTALLED</a></h4>
|
|
<p><code>GLIBC_INSTALLED=src/work/glibc/glibc_installed/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#busybox_installed" id="busybox_installed">BUSYBOX_INSTALLED</a></h4>
|
|
<p><code>BUSYBOX_INSTALLED=src/work/busybox/busybox_installed/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#sysroot" id="sysroot">SYSROOT</a></h4>
|
|
<p><code>SYSROOT=src/work/sysroot/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#rootfs" id="rootfs">ROOTFS</a></h4>
|
|
<p><code>ROOTFS=src/work/rootfs/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#overlay_rootfs" id="overlay_rootfs">OVERLAY_ROOTFS</a></h4>
|
|
<p><code>OVERLAY_ROOTFS=src/work/overlay_rootfs/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#isoimage" id="isoimage">ISOIMAGE</a></h4>
|
|
<p><code>OVERLAY_ROOTFS=src/work/isoimage/</code></p>
|
|
<p>TODO...</p>
|
|
<h4><a class="header" href="#isoimage_overlay" id="isoimage_overlay">ISOIMAGE_OVERLAY</a></h4>
|
|
<p><code>OVERLAY_ROOTFS=src/work/isoimage_overlay/</code></p>
|
|
<p>TODO...</p>
|
|
<h2><a class="header" href="#functions" id="functions">Functions</a></h2>
|
|
<h4><a class="header" href="#read_propertyprop_name" id="read_propertyprop_name">read_property(prop_name)</a></h4>
|
|
<p>This function reads properties from the main <code>.config</code> file.</p>
|
|
<pre><code class="language-bash"># Example
|
|
|
|
JOB_FACTOR=`read_property JOB_FACTOR`
|
|
</code></pre>
|
|
<h4><a class="header" href="#download_sourceurl-file_to_save" id="download_sourceurl-file_to_save">download_source(url, file_to_save)</a></h4>
|
|
<p>This function downloads the <code>url</code> resource and saves it as <code>$file_to_save</code>.</p>
|
|
<pre><code class="language-bash"># Example
|
|
#
|
|
# This is the filesystem structure before the execution
|
|
# of the function.
|
|
#
|
|
# src/
|
|
# └── source/
|
|
# └── (no files/folders)
|
|
|
|
download_source \
|
|
'https://busybox.net/downloads/busybox-1.32.0.tar.bz2' \
|
|
$SOURCE_DIR/busybox-1.32.0.tar.bz2
|
|
|
|
# This is the filesystem structure after the execution
|
|
# of the function.
|
|
#
|
|
# src/
|
|
# └── source/
|
|
# └── busybox-1.32.0.tar.bz2
|
|
</code></pre>
|
|
<h4><a class="header" href="#extract_sourcearchive_file-dest_dir" id="extract_sourcearchive_file-dest_dir">extract_source(archive_file, dest_dir)</a></h4>
|
|
<p>This function extracts the archive <code>archive_file</code> in the directory <code>src/work/$dest_dir/</code>.</p>
|
|
<pre><code class="language-bash"># Example
|
|
#
|
|
# This is the filesystem structure before the execution
|
|
# of the function.
|
|
#
|
|
# src/
|
|
# ├── source/
|
|
# │ └── busybox-1.32.0.tar.bz2
|
|
# └── work/
|
|
# └── (no files/folders)
|
|
|
|
extract_source \
|
|
$SOURCE_DIR/busybox-1.32.0.tar.bz2 \
|
|
busybox
|
|
|
|
# This is the filesystem structure after the execution
|
|
# of the function.
|
|
#
|
|
# src/
|
|
# ├── source/
|
|
# │ └── busybox-1.32.0.tar.bz2
|
|
# └── work/
|
|
# └── busybox
|
|
# └── busybox-1.32.0/
|
|
</code></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
|
|
<a rel="prev" href="build_scripts.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
|
|
<a rel="next" href="00_clean.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
|
|
<a rel="prev" href="build_scripts.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
|
|
<a rel="next" href="00_clean.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
<!-- Livereload script (if served using the cli tool) -->
|
|
<script type="text/javascript">
|
|
var socket = new WebSocket("ws://localhost:3000/__livereload");
|
|
socket.onmessage = function (event) {
|
|
if (event.data === "reload") {
|
|
socket.close();
|
|
location.reload();
|
|
}
|
|
};
|
|
|
|
window.onbeforeunload = function() {
|
|
socket.close();
|
|
}
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|