Documentation update for 3.9.0

storaged-project · Jan 31, 2024 · fe4a9f8 · fe4a9f8
1 parent a5a8628
commit fe4a9f8
Show file tree

Hide file tree

Showing 40 changed files with 1,448 additions and 2,503 deletions.
diff --git a/_inheritance.html b/_inheritance.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Test Suite Inheritance Diagram &#8212; Blivet 3.8.2 documentation</title>
+    <title>Test Suite Inheritance Diagram &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Test Suite Inheritance Diagram</a></li> 
       </ul>
     </div>  
@@ -93,12 +93,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Test Suite Inheritance Diagram</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.8.2',
+    VERSION: '3.9.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api.html b/api.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Public API &#8212; Blivet 3.8.2 documentation</title>
+    <title>Public API &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="intro.html" title="Introduction to Blivet"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Public API</a></li> 
       </ul>
     </div>  
@@ -198,12 +198,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="intro.html" title="Introduction to Blivet"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Blivet 3.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Public API</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/api/blivet.html b/api/blivet.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>blivet &#8212; Blivet 3.8.2 documentation</title>
+    <title>blivet &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../api.html" title="Public API"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" accesskey="U">Public API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">blivet</a></li> 
       </ul>
@@ -457,13 +457,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../api.html" title="Public API"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">blivet</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/api/devices.html b/api/devices.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>devices &#8212; Blivet 3.8.2 documentation</title>
+    <title>devices &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="blivet.html" title="blivet"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" accesskey="U">blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">devices</a></li> 
@@ -369,14 +369,14 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="blivet.html" title="blivet"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" >blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">devices</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/api/events.html b/api/events.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>events &#8212; Blivet 3.8.2 documentation</title>
+    <title>events &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="devices.html" title="devices"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" accesskey="U">blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">events</a></li> 
@@ -125,14 +125,14 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="devices.html" title="devices"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" >blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">events</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>

diff --git a/api/formats.html b/api/formats.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>formats &#8212; Blivet 3.8.2 documentation</title>
+    <title>formats &#8212; Blivet 3.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -37,7 +37,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="events.html" title="events"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" accesskey="U">blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">formats</a></li> 
@@ -135,7 +135,6 @@ <h1>formats<a class="headerlink" href="#formats" title="Permalink to this headin
 </dd>
 </dl>
 </li>
-<li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.AppleBootstrapFS" title="blivet.formats.fs.AppleBootstrapFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">AppleBootstrapFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.BindFS" title="blivet.formats.fs.BindFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">BindFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><dl class="simple">
 <dt><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.BTRFS" title="blivet.formats.fs.BTRFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">BTRFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</dt><dd><ul>
@@ -154,18 +153,15 @@ <h1>formats<a class="headerlink" href="#formats" title="Permalink to this headin
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.FATFS" title="blivet.formats.fs.FATFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">FATFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.F2FS" title="blivet.formats.fs.F2FS"><code class="xref py py-class docutils literal notranslate"><span class="pre">F2FS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.GFS2" title="blivet.formats.fs.GFS2"><code class="xref py py-class docutils literal notranslate"><span class="pre">GFS2</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
-<li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.HFS" title="blivet.formats.fs.HFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">HFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.HFSPlus" title="blivet.formats.fs.HFSPlus"><code class="xref py py-class docutils literal notranslate"><span class="pre">HFSPlus</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.Iso9660FS" title="blivet.formats.fs.Iso9660FS"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iso9660FS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.UDFFS" title="blivet.formats.fs.UDFFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">UDFFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
-<li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.JFS" title="blivet.formats.fs.JFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">JFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.MacEFIFS" title="blivet.formats.fs.MacEFIFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">MacEFIFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.NFS" title="blivet.formats.fs.NFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">NFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.NFSv4" title="blivet.formats.fs.NFSv4"><code class="xref py py-class docutils literal notranslate"><span class="pre">NFSv4</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.NoDevFS" title="blivet.formats.fs.NoDevFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">NoDevFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.NTFS" title="blivet.formats.fs.NTFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">NTFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.ProcFS" title="blivet.formats.fs.ProcFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProcFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
-<li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.ReiserFS" title="blivet.formats.fs.ReiserFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReiserFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.SELinuxFS" title="blivet.formats.fs.SELinuxFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">SELinuxFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.SysFS" title="blivet.formats.fs.SysFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">SysFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
 <li><p><a class="reference internal" href="../blivet/blivet.formats.html#blivet.formats.fs.TmpFS" title="blivet.formats.fs.TmpFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">TmpFS</span></code></a> (see <a class="reference internal" href="#fsapi"><span class="std std-ref">inherited public API</span></a>)</p></li>
@@ -317,14 +313,14 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="events.html" title="events"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Blivet 3.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../api.html" >Public API</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="blivet.html" >blivet</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">formats</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2013-2023, Red Hat, Inc..
+        &#169; Copyright 2013-2024, Red Hat, Inc..
       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
     </div>
   </body>