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>
Package selections</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>
Package selections</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>
Package selections</h1>
</td>
<td class="filecell">Packages.ycp</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td>
<ul>
<li>Anas Nashif <nashif@suse.de></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>AddOnProduct</li>
<li>Arch</li>
<li>DefaultDesktop</li>
<li>Directory</li>
<li>FileUtils</li>
<li>InstURL</li>
<li>Installation</li>
<li>Kernel</li>
<li>Label</li>
<li>Language</li>
<li>Linuxrc</li>
<li>Mode</li>
<li>PackageCallbacks</li>
<li>PackageCallbacks</li>
<li>PackagesProposal</li>
<li>Popup</li>
<li>Product</li>
<li>ProductControl</li>
<li>ProductFeatures</li>
<li>Report</li>
<li>SlideShow</li>
<li>Slides</li>
<li>SourceDialogs</li>
<li>SpaceCalculation</li>
<li>Stage</li>
<li>String</li>
<li>URL</li>
<li>Wizard</li>
<li>WorkflowManager</li>
</ul>
<h1>Includes</h1>
<ul>
<li>packager/load_release_notes.ycp</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#AdjustSourcePropertiesAccordingToProduct">AdjustSourcePropertiesAccordingToProduct (integer src_id)</a>
</li>
<li>
<a href="#CheckContentFile">CheckContentFile (integer source)</a>
</li>
<li>
<a href="#CheckDiskSize">CheckDiskSize (boolean init)</a>
</li>
<li>
<a href="#CheckOldAddOns">CheckOldAddOns (map & ret)</a>
</li>
<li>
<a href="#ComputeSystemPackageList">ComputeSystemPackageList ()</a>
</li>
<li>
<a href="#CountSizeToBeDownloaded">CountSizeToBeDownloaded ()</a>
</li>
<li>
<a href="#CountSizeToBeInstalled">CountSizeToBeInstalled ()</a>
</li>
<li>
<a href="#GetBaseSourceID">GetBaseSourceID ()</a>
</li>
<li>
<a href="#InfoAboutSubOptimalDistribution">InfoAboutSubOptimalDistribution ()</a>
</li>
<li>
<a href="#Initialize">Initialize (boolean show_popup)</a>
</li>
<li>
<a href="#InitializeAddOnProducts">InitializeAddOnProducts ()</a>
</li>
<li>
<a href="#InitializeCatalogs">InitializeCatalogs ()</a>
</li>
<li>
<a href="#ListSelected">ListSelected (symbol what, string format)</a>
</li>
<li>
<a href="#Proposal">Proposal (boolean force_reset, boolean reinit, boolean simple)</a>
</li>
<li>
<a href="#Reset">Reset (list<symbol> keep)</a>
</li>
<li>
<a href="#SelectProduct">SelectProduct ()</a>
</li>
<li>
<a href="#Summary">Summary (list<symbol> flags, boolean use_cache)</a>
</li>
<li>
<a href="#SummaryOutput">SummaryOutput (list<symbol> flags)</a>
</li>
<li>
<a href="#addAdditionalPackage">addAdditionalPackage (string package)</a>
</li>
</ul>
<h1>Local Variables</h1>
<ul>
<li>
<a href="#additional_packages">additional_packages</a>
</li>
<li>
<a href="#full_repropose">full_repropose</a>
</li>
<li>
<a href="#init_called">init_called</a>
</li>
<li>
<a href="#init_error">init_error</a>
</li>
<li>
<a href="#init_in_progress">init_in_progress</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#ImportGPGKeys">ImportGPGKeys ()</a>
</li>
<li>
<a href="#SelectSystemPackages">SelectSystemPackages (boolean reselect)</a>
</li>
<li>
<a href="#SelectSystemPatterns">SelectSystemPatterns (boolean reselect)</a>
</li>
<li>
<a href="#architecturePackages">architecturePackages ()</a>
</li>
<li>
<a href="#boardPackages">boardPackages ()</a>
</li>
<li>
<a href="#graphicPackages">graphicPackages ()</a>
</li>
<li>
<a href="#javaPackages">javaPackages ()</a>
</li>
<li>
<a href="#modePackages">modePackages ()</a>
</li>
<li>
<a href="#sourceAccessPackages">sourceAccessPackages ()</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="full_repropose">local
<b>full_repropose
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Force full proposal routine next run</p>
<div class="sigbox">
<span class="sig" id="init_called">local
<b>init_called
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
repository has been initialized?</p>
<div class="sigbox">
<span class="sig" id="init_in_progress">local
<b>init_in_progress
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
repository initialization is WIP</p>
<div class="sigbox">
<span class="sig" id="init_error">local
<b>init_error
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Error which occurred during repository initialization</p>
<div class="sigbox">
<span class="sig" id="additional_packages">local
<b>additional_packages
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Packages to be selected when proposing the list</p>
<div class="sigbox">
<span class="sig" id="ListSelected">global
<b>ListSelected (symbol what, string format)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
List selected resolvables of specified kind</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">what</span>
</td>
<td class="descbox">symbol specifying the kind of resolvables to select</td>
</tr>
<tr>
<td class="pbox">
<span class="p">format</span>
</td>
<td class="descbox">string format string to print summaries in</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 selected resolvables</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CountSizeToBeInstalled">global
<b>CountSizeToBeInstalled ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Count the total size of packages to be installed</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">formatted size of packages to be installed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CountSizeToBeDownloaded">global
<b>CountSizeToBeDownloaded ()
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Count the total size of packages to be installed</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">size of packages to be installed (in bytes)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InfoAboutSubOptimalDistribution">global
<b>InfoAboutSubOptimalDistribution ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return information about suboptimal distribution if relevant</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">the information string or empty string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SummaryOutput">global
<b>SummaryOutput (list<symbol> flags)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Return the summary output lines</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">flags</span>
</td>
<td class="descbox">a list of flags, allowed are `product, `pattern, `selection,
`size, `desktop</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 output lines</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CheckDiskSize">global
<b>CheckDiskSize (boolean init)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check if selected software fits on the partitions</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">init</span>
</td>
<td class="descbox">boolean true if partition sizes have changed</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 selected software fits, false otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CheckOldAddOns">global
<b>CheckOldAddOns (map & ret)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Checks which products have been selected for removal and modifies
the warning messages accordingly.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">ret</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary (list<symbol> flags, boolean use_cache)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Print the installatino proposal summary</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">flags</span>
</td>
<td class="descbox">a list of symbols, see above</td>
</tr>
<tr>
<td class="pbox">
<span class="p">use_cache</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Reset">global
<b>Reset (list<symbol> keep)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Reset package selection, but keep objects of specified type</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">keep</span>
</td>
<td class="descbox">a list of symbols specifying type of objects to be kept</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitializeAddOnProducts">global
<b>InitializeAddOnProducts ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize add-on products provided by the repository</p>
<div class="sigbox">
<span class="sig" id="addAdditionalPackage">global
<b>addAdditionalPackage (string package)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Add a package to list to be selected before proposal
Can be called only before the installation proposal, later doesn't
have any effect.
OBSOLETE! Please, use PackagesProposal::AddResolvables() instead.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">package</span>
</td>
<td class="descbox">string package to be selected</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="architecturePackages">local
<b>architecturePackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Compute architecture packages</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="graphicPackages">local
<b>graphicPackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
graphicPackages ()
Compute graphic (x11) packages</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string) list of rpm packages needed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="modePackages">local
<b>modePackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Compute special packages</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="javaPackages">local
<b>javaPackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Compute special java packages</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="boardPackages">local
<b>boardPackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Compute board (vendor) dependant packages</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="sourceAccessPackages">local
<b>sourceAccessPackages ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Compute packages required to access the repository</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">(string) list of the required packages</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ComputeSystemPackageList">global
<b>ComputeSystemPackageList ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Build and return list of packages which depends on the
the current target system and the preselected packages
(architecture, X11....)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">packages</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CheckContentFile">global
<b>CheckContentFile (integer source)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Check whether content file in the specified repository is the same
as the one in the ramdisk</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">source</span>
</td>
<td class="descbox">integer the repository ID 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 content files match</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ImportGPGKeys">local
<b>ImportGPGKeys ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Import GPG keys found in the inst-sys</p>
<div class="sigbox">
<span class="sig" id="GetBaseSourceID">global
<b>GetBaseSourceID ()
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Returns ID of the base product repository.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">base source ID</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AdjustSourcePropertiesAccordingToProduct">global
<b>AdjustSourcePropertiesAccordingToProduct (integer src_id)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Adjusts repository name according to LABEL in content file
or a first product found on the media (as a fallback).</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">src_id</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">if successful
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#BNC #481828">BNC #481828</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Initialize">global
<b>Initialize (boolean show_popup)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize the repositories</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">show_popup</span>
</td>
<td class="descbox">boolean true to display information about initialization</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SelectProduct">global
<b>SelectProduct ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Select the base product on the media for installation</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="SelectSystemPatterns">local
<b>SelectSystemPatterns (boolean reselect)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Select system patterns</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">reselect</span>
</td>
<td class="descbox">boolean true to select only those which are alrady selected</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SelectSystemPackages">local
<b>SelectSystemPackages (boolean reselect)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Select system packages</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">reselect</span>
</td>
<td class="descbox">boolean true to select only those which are alrady selected</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Proposal">global
<b>Proposal (boolean force_reset, boolean reinit, boolean simple)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Make a proposal for package selection</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">force_reset</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">reinit</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">simple</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">for the API proposal</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitializeCatalogs">global
<b>InitializeCatalogs ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize the repositories with popup feedback
Use Packages::Initialize (true) instead</p>
</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