Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the new --rootfs-type options #1417

Merged
merged 4 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ def read_version():
#epub_use_index = True

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/3': None}
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
Expand Down
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f083405273687eff9d5c4dc4771aebc3
config: a853571d656ae5212a1a9600dd43a5c2
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/html/.doctrees/livemedia-creator.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/lorax.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/mkksiso.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/pylorax.doctree
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; Lorax 41.1 documentation</title>
<title>Overview: module code &mdash; Lorax 41.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=330c1f8c" />



<script src="../_static/documentation_options.js?v=0a3d5615"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/documentation_options.js?v=99bd5866"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand All @@ -29,7 +29,7 @@
Lorax
</a>
<div class="version">
41.1
41.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
49 changes: 42 additions & 7 deletions docs/html/_sources/lorax.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,48 @@ by the installation environment. In addition to the ``remove`` template command
Removes kernel modules


The squashfs filesystem
~~~~~~~~~~~~~~~~~~~~~~~

After ``runtime-*.tmpl`` templates have finished their work lorax creates an
empty ext4 filesystem, copies the remaining files to it, and makes a squashfs
filesystem of it. This file is the / of the boot.iso's installer environment
and is what is in the LiveOS/squashfs.img file on the iso.
The install.img root filesystem
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
The erofs options are still experimental. They require dracut-103 or later
in order for the iso to boot, and the kernel erofs driver must support the
compression type selected.
For more information see the `erofs website <https://erofs.docs.kernel.org/en/latest/>`_.

After ``runtime-*.tmpl`` templates have finished their work lorax creates the
root filesystem in the ``install.img`` file. The ``anaconda-dracut`` and
``dracut-live`` dracut modules detect the type of rootfs and mounts it for booting.
There are currently four possible formats for this file:

* Plain squashfs filesystem (DEFAULT)
This can be mounted directly and is simply a squashfs compressed root filesystem.
It is created by default, when ``--squashfs-only``, or ``--rootfs-type squashfs``
are passed to lorax.
* squashfs compressed ext4 filesystem
This creates a ``LiveOS/rootfs.img`` ext4 filesystem of the root filesystem and
then compresses that with squashfs. This is selected when passing
``--rootfs-type squashfs-ext4`` to lorax.
* Plain erofs filesystem
This can be mounted directly and is an erofs filesystem compressed using the
lzma compression algorithm. This is created when passing ``--rootfs-type erofs``
to lorax.
* erofs compressed ext4 filesystem
This is like the ``squashfs-ext4`` option except that it uses erofs. It is
selected when passing ``--rootfs-type erofs-ext4`` to lorax.

When using erofs the current default is to use lzma compression. You can use
the ``[compression.erofs]`` section of the lorax configuration file to pass a
different compression type and arguments to the ``mkfs.erofs`` program. For
example to use lz4 with extra options create a lorax.conf file with::

[compression.erofs]
type = lz4
args = -E dedupe,all-fragments -C 65536

And run the build with::

lorax -c ./lorax.conf --rootfs-type erofs ...


iso creation
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '41.1',
VERSION: '41.3',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];


/* Non-minified version is copied as a separate JS file, is available */
/* Non-minified version is copied as a separate JS file, if available */

/**
* Porter Stemmer
Expand Down
Loading