ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
Bootloader installation and configuration
</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
Bootloader installation and configuration
</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
Bootloader installation and configuration
</h1>
</td>
<td class="filecell">
include/bootloader/routines/misc-common.ycp
</td>
</tr>
<tr>
<td>
Miscelaneous functions for bootloader configuration and installation
</td>
</tr>
<tr>
<td>
<ul>
<li> Jiri Srain <jsrain@suse.cz></li>
<li> Olaf Dabrunz <od@suse.de></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
WARNING:
To be included to BootCommon.ycp only, requires function
getLoaderType to avoid include-import cycle
Use import "BootCommon" instead.
<h1>Imports</h1>
<ul>
<li>Directory</li>
<li>FileUtils</li>
<li>FileUtils</li>
<li>Installation</li>
<li>Kernel</li>
<li>Misc</li>
<li>Mode</li>
<li>ProductFeatures</li>
<li>Report</li>
<li>Stage</li>
<li>Storage</li>
<li>StorageDevices</li>
<li>String</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#BootloaderInstallable">BootloaderInstallable ()</a>
</li>
<li>
<a href="#GetAdditionalFailsafeParams">GetAdditionalFailsafeParams ()</a>
</li>
<li>
<a href="#GetAdditionalKernelParams">GetAdditionalKernelParams ()</a>
</li>
<li>
<a href="#GetBootloaderDevice">GetBootloaderDevice ()</a>
</li>
<li>
<a href="#GetBootloaderDevices">GetBootloaderDevices ()</a>
</li>
<li>
<a href="#InstallingToFloppy">InstallingToFloppy ()</a>
</li>
<li>
<a href="#IsPartitionBootable">IsPartitionBootable (string device)</a>
</li>
<li>
<a href="#ListAdditionalKernelParams">ListAdditionalKernelParams ()</a>
</li>
<li>
<a href="#MemtestPresent">MemtestPresent ()</a>
</li>
<li>
<a href="#UpdateDevice">UpdateDevice (string device)</a>
</li>
<li>
<a href="#UpdateGfxMenuContents">UpdateGfxMenuContents ()</a>
</li>
<li>
<a href="#UpdateInstallationKernelParameters">UpdateInstallationKernelParameters ()</a>
</li>
<li>
<a href="#UpdateKernelParams">UpdateKernelParams (string orig)</a>
</li>
<li>
<a href="#getAnyTypeAttrib">getAnyTypeAttrib (string attrib, any defaultv)</a>
</li>
<li>
<a href="#getBooleanAttrib">getBooleanAttrib (string attrib)</a>
</li>
<li>
<a href="#getBootPartition">getBootPartition ()</a>
</li>
<li>
<a href="#getKernelParamFromLine">getKernelParamFromLine (string line, string key)</a>
</li>
<li>
<a href="#getLoaderName">getLoaderName (string bootloader, symbol mode)</a>
</li>
<li>
<a href="#getSwapPartitions">getSwapPartitions ()</a>
</li>
<li>
<a href="#isBlank">isBlank (string s)</a>
</li>
<li>
<a href="#remapGlobals">remapGlobals (map<string,string> globals_set)</a>
</li>
<li>
<a href="#remapSections">remapSections (list<map<string,any> > sec)</a>
</li>
<li>
<a href="#restoreMBR">restoreMBR (string device)</a>
</li>
<li>
<a href="#splitPath">splitPath (string fullpth)</a>
</li>
<li>
<a href="#translateSectionTitle">translateSectionTitle (string orig)</a>
</li>
<li>
<a href="#updateMBR">updateMBR ()</a>
</li>
<li>
<a href="#updateTimeoutPopupForFloppy">updateTimeoutPopupForFloppy (string bootloader)</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#AddMbrToDescription">AddMbrToDescription (string descr, string device)</a>
</li>
<li>
<a href="#IsMbr">IsMbr (string device)</a>
</li>
<li>
<a href="#ListKernelParamsInLine">ListKernelParamsInLine (string line)</a>
</li>
<li>
<a href="#abs">abs (integer value)</a>
</li>
<li>
<a href="#difflist">difflist (list a, list b)</a>
</li>
<li>
<a href="#getFileChangeDate">getFileChangeDate (string filename)</a>
</li>
<li>
<a href="#getMbrsToRewrite">getMbrsToRewrite ()</a>
</li>
<li>
<a href="#getPartitionToActivate">getPartitionToActivate (string boot_partition, string loader_device)</a>
</li>
<li>
<a href="#getPartitionsToActivate">getPartitionsToActivate ()</a>
</li>
<li>
<a href="#remapResume">remapResume (string append, boolean to_persistent)</a>
</li>
<li>
<a href="#saveMBR">saveMBR (string device)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="getLoaderName">global
<b>getLoaderName (string bootloader, symbol mode)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
return printable name of bootloader</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">bootloader</span>
</td>
<td class="descbox">string bootloader type internal string</td>
</tr>
<tr>
<td class="pbox">
<span class="p">mode</span>
</td>
<td class="descbox">symbol `combo or `summary (because of capitalization)</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">printable bootloader name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getBooleanAttrib">global
<b>getBooleanAttrib (string attrib)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get value of specified boolean bootloader attribute</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">attrib</span>
</td>
<td class="descbox">string attribute name</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">value of attribute</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getAnyTypeAttrib">global
<b>getAnyTypeAttrib (string attrib, any defaultv)
<span class="a"> -> </span>
<span class="t">any</span>
</b>
</span>
</div>
<p>
Get value of specified bootloader attribute</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">attrib</span>
</td>
<td class="descbox">string attribute name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">defaultv</span>
</td>
<td class="descbox">any default value of the attribute (if not found)</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">value of attribute</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="updateTimeoutPopupForFloppy">global
<b>updateTimeoutPopupForFloppy (string bootloader)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update the text of countdown widget</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">bootloader</span>
</td>
<td class="descbox">string printable name of used bootloader</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="remapGlobals">global
<b>remapGlobals (map<string,string> globals_set)
<span class="a"> -> </span>
<span class="t">map<string,string></span>
</b>
</span>
</div>
<p>
Function remap globals settings "boot_custom" device name (/dev/sda)
or to label (ufo_partition)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">globals_set</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">globals</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="remapResume">local
<b>remapResume (string append, boolean to_persistent)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Function remap "resume" from section (append) to device name (/dev/sda)
or to label (ufo_partition)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">append</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">to_persistent</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">sections</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="remapSections">global
<b>remapSections (list<map<string,any> > sec)
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
Function remap section "root" and "resume" to device name (/dev/sda)
or to label (ufo_partition)
it also prepared measured files for export</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sec</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">list of sections</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="isBlank">global
<b>isBlank (string s)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
returns true if char is blank (newline, tab or space)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">s</span>
</td>
<td class="descbox">single char string</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">blank/non blank</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="difflist">local
<b>difflist (list a, list b)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
returns list difference A \ B (items that are in A and are not in B)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">a</span>
</td>
<td class="descbox">list A</td>
</tr>
<tr>
<td class="pbox">
<span class="p">b</span>
</td>
<td class="descbox">list B</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">see above</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="splitPath">global
<b>splitPath (string fullpth)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
translate filename path (eg. /boot/kernel) to list of device
and relative path</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">fullpth</span>
</td>
<td class="descbox">string fileststem path (eg. /boot/vmlinuz)</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list containing device and relative path,
eg. ["/dev/hda1", "/vmlinuz"]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetBootloaderDevice">global
<b>GetBootloaderDevice ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get bootloader device for specified location
FIXME: this function is being phased out. Keeping it around until
selected_location and loader_device can be dropped for all bootloader
types.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">device name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetBootloaderDevices">global
<b>GetBootloaderDevices ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get list of bootloader device names for all selected or specified
locations</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">device names</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="IsPartitionBootable">global
<b>IsPartitionBootable (string device)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if the PBR of the given partition seems to contain a known boot block</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string partition device to check</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if the PBR seems to contain a known boot block</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InstallingToFloppy">global
<b>InstallingToFloppy ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if installation to floppy is performed</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if installing bootloader to floppy</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ListKernelParamsInLine">local
<b>ListKernelParamsInLine (string line)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get the list of particular kernel parameters</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">line</span>
</td>
<td class="descbox">string the whole kernel command line</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of the kernel parameters split each separaterlly</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getKernelParamFromLine">global
<b>getKernelParamFromLine (string line, string key)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
get kernel parameter from kernel command line</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">line</span>
</td>
<td class="descbox">string original line</td>
</tr>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox">string parameter key</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">value, "false" if not present,
"true" if present key without value</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">Info:</div>
<p>
set kernel parameter to GRUB command line</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">key</span>
</td>
<td class="descbox">string parameter key</td>
</tr>
<tr>
<td class="pbox">
<span class="p">line</span>
</td>
<td class="descbox">string original line</td>
</tr>
<tr>
<td class="pbox">
<span class="p">value</span>
</td>
<td class="descbox">string value, "false" to remove key,
"true" to add key without value</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">new kernel command line</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getPartitionToActivate">local
<b>getPartitionToActivate (string boot_partition, string loader_device)
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
Get partition which should be activated if doing it during bl inst.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">boot_partition</span>
</td>
<td class="descbox">string the partition holding /boot subtree</td>
</tr>
<tr>
<td class="pbox">
<span class="p">loader_device</span>
</td>
<td class="descbox">string the device to install bootloader to</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a map $[ "dev" : string, "mbr": string, "num": any]
containing device (eg. "/dev/hda4"), disk (eg. "/dev/hda") and
partition number (eg. 4)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getPartitionsToActivate">local
<b>getPartitionsToActivate ()
<span class="a"> -> </span>
<span class="t">list<map<string, any> ></span>
</b>
</span>
</div>
<p>
Get a list of partitions to activate if user wants to activate
boot partition</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of partitions to activate</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getMbrsToRewrite">local
<b>getMbrsToRewrite ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get the list of MBR disks that should be rewritten by generic code
if user wants to do so</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of device names to be rewritten</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getFileChangeDate">local
<b>getFileChangeDate (string filename)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get last change time of file</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">filename</span>
</td>
<td class="descbox">string name of file</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">last change date as YYYY-MM-DD-HH-MM-SS</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="saveMBR">local
<b>saveMBR (string device)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Save current MBR to /boot/backup_mbr
Also save to /var/lib/YaST2/backup_boot_sectors/%device, if some
existing, rename it</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string name of device</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="updateMBR">global
<b>updateMBR ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Update contents of MBR (active partition and booting code)
FIXME move tis function to lilolike.ycp</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="restoreMBR">global
<b>restoreMBR (string device)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Rewrite current MBR with /var/lib/YaST2/backup_boot_sectors/%device
Warning!!! don't use for bootsectors, 440 bytes of sector are written</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string device to rewrite MBR to</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateKernelParams">global
<b>UpdateKernelParams (string orig)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Update kernel parameters if some were added in Kernel module</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">orig</span>
</td>
<td class="descbox">original kernel parameters or kernel command line</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">kernel command line or parameters with added new parameters</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getSwapPartitions">global
<b>getSwapPartitions ()
<span class="a"> -> </span>
<span class="t">map<string, integer></span>
</b>
</span>
</div>
<p>
Get map of swap partitions</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a map where key is partition name and value its size</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="translateSectionTitle">global
<b>translateSectionTitle (string orig)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create translated name of a section</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">orig</span>
</td>
<td class="descbox">string original section name</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">translated section name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="IsMbr">local
<b>IsMbr (string device)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if device is MBR of a disk</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string device to check</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if is MBR</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddMbrToDescription">local
<b>AddMbrToDescription (string descr, string device)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Add '(MBR)' to the disk description if it is a MBR of some partition</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">descr</span>
</td>
<td class="descbox">string disk description</td>
</tr>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string disk device</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">updated description</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateInstallationKernelParameters">global
<b>UpdateInstallationKernelParameters ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update the Kernel::vgaType value to the saved one if not defined</p>
<div class="sigbox">
<span class="sig" id="GetAdditionalFailsafeParams">global
<b>GetAdditionalFailsafeParams ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get additional kernel parameters</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">additional kernel parameters</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetAdditionalKernelParams">global
<b>GetAdditionalKernelParams ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get additional kernel parameters from control file</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">additional kernel parameters</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ListAdditionalKernelParams">global
<b>ListAdditionalKernelParams ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get additional kernel parameters splitted to a list</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of additional kernel parameters</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateGfxMenuContents">global
<b>UpdateGfxMenuContents ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Update graphical bootloader to contain help text of current language
And make the selected installation language default</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateDevice">global
<b>UpdateDevice (string device)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Update device name according to changes in kernel (eg. SATA)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">string the original device name</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">updated device</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="MemtestPresent">global
<b>MemtestPresent ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if memtest86 is present</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if memtest86 section is to be proposed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="BootloaderInstallable">global
<b>BootloaderInstallable ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if the bootloader can be installed at all with current configuration</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if it can</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="abs">local
<b>abs (integer value)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Function return absolute value of arg</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">value</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">absolute value</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getBootPartition">global
<b>getBootPartition ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Function return boot device it means
return boot partition or root partition if boot partition deosn't exist
function return "" if boot partition or root partition is not defined (autoyast)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">name of boot device (partition)</td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018