KIWIXML Info


Public methods

Private methods


addArchives

Add the given archives to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array - the given image type of the profiles being processed

Defined on line: 467

addBootstrapArchives

Add the given archives to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array - the given image type of the profiles being processed

Defined on line: 525

Called in

addBootstrapPackages

Add the given packages to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 576

Called in

addDrivers

Add the given drivers to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 625

Called in

addFilesToDelete

Add the given StripData objects to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 688

Called in

addLibsToKeep

Add the given StripData objects to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 740

Called in

addPackageCollections

Add the given package collections to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array - the given image type of the profiles being processed

Defined on line: 860

Called in

addPackages

Add the given packages to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array - the given image type of the profiles being processed

Defined on line: 792

Called in

addPackagesToDelete

Add the given packages to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 918

Called in

addPackagesToIgnore

Add the given packages to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 967

Called in

addRepositories

Add the given repositories to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 1016

Called in

addSystemDisk

Add a KIWIXMLSystemdiskData object to the type that is currently the build type.

Defined on line: 1128

Called in

addToolsToKeep

Add the given StripData objects to - the currently active profiles (not default) ~ if the second argument is undefined - the default profile ~ if second argument is the keyword "default" - the specified profiles ~ if the second argument is a reference to an array

Defined on line: 1163

Called in

discardReplacableRepos

Remove all repositories marked as replaceable

Defined on line: 1215

Called in

getActiveProfileNames

Return an array ref containing the names of the active profiles; this does not reveal the default (kiwi_default) name, as this is always active

Defined on line: 1243

Called in

getArch

Return the architecture currently used for data selection

Defined on line: 5686

getArchives

Return an array ref containing ArchiveData objects

Defined on line: 1264

Called in

getBootDeletePackages

Return an array ref containing PackageData objects for the packages that should be deleted.

Defined on line: 1293

Called in

getBootIncludeArchives

Return an array ref containing ArchiveData objects

Defined on line: 1305

Called in

getBootIncludePackageCollections

Return an array ref containing PackageCollectData objects

Defined on line: 1359

Called in

getBootIncludePackages

Return an array ref containing PackageData objects

Defined on line: 1316

Called in

getBootKernel

Missing

Defined on line: 1458

getBootProfile

Missing

Defined on line: 1449

getBootstrapPackages

Return an array ref containing PackageData objects for the packages that should be used to bootstrap the image. The packages marked to become bootincluded will also be handled in the bootstrap phase

Defined on line: 1370

Called in

getConfigName

Missing

Defined on line: 5572

Called in

getConfiguredTypeNames

Return an array ref of image type names avaliable across the selected profiles.

Defined on line: 1400

Called in

getDUDArchitectures

Return a hash ref containing strings indicating the driver update disk architectures.

Defined on line: 1467

Called in

getDUDInstallSystemPackages

Return an array ref containing ProductPackageData objects

Defined on line: 1482

Called in

getDUDModulePackages

Return an array ref containing ProductPackageData objects

Defined on line: 1496

Called in

getDUDPackages

Return an array ref containing ProductPackageData objects

Defined on line: 1510

getDescriptionInfo

Return an object that encapsulates the description information

Defined on line: 1426

Called in

getDrivers

Return an array ref containing DriverData objects for the current selected build profile(s)

Defined on line: 1437

Called in

getFilesToDelete

Return an array ref containing StripData objects for the current selected build profile(s)

Defined on line: 1524

getImageDisplayName

Get the display name of the logical extend

Defined on line: 1536

Called in

getImageID

Missing

Defined on line: 5581

Called in

getImageName

Return the configured image name

Defined on line: 1560

Called in

getImageType

Return a TypeData object for the selected build type

Defined on line: 1571

Called in

getInstSourceSatSolvable

Missing

Defined on line: 5697

Called in

getInstallOption

Return the install option type setting. decides for plusRecommended if it was selected by a profile even if the default setting is at onlyRequired

Defined on line: 1582

Called in

getLibsToKeep

Return an array ref containing StripData objects for the current selected build profile(s)

Defined on line: 1614

getOEMConfig

Return a OEMConfigData object for the selected build type

Defined on line: 1638

Called in

getPXEConfig

Return a PXEDeployData object for the PXE boot configuration of the current build type.

Defined on line: 1943

Called in

getPXEConfigData

Return an array ref containing PXEDeployConfigData objects for current build type.

Defined on line: 1955

Called in

getPackageCollections

Return an array ref containing PackageCollectData objects

Defined on line: 1713

getPackages

Return an array ref containing PackageData objects

Defined on line: 1669

Called in

getPackagesToDelete

Return an array ref containing PackageData objects for the packages that should be deleted.

Defined on line: 1727

getPackagesToIgnore

Return an array ref containing IgnorePackageData objects The method is private as it is needed for filtering only. Clients of the XML object should not do any filtering on the data received.

Defined on line: 1280

Called in

getPreferences

Return a new KIWIXMLPreferenceData object which references the sum of all default and currently selected build profile(s)

Defined on line: 1768

Called in

getProductArchitectures

Return an array ref of ProductArchitectureData objects.

Defined on line: 1796

getProductMetaChroots

Return an array ref of ProductMetaChrootData objects specified as metadata.

Defined on line: 1810

Called in

getProductMetaFiles

Return an array ref of ProductMetaFileData objects specified as metadata.

Defined on line: 1825

Called in

getProductMetaPackages

Return an array ref of ProductPackageData objects specified as metadata.

Defined on line: 1840

Called in

getProductOptions

Return a ProductOptionsData object providing all information from , , and elements.

Defined on line: 1855

Called in

getProductRepositories

Return an array ref of InstRepositoryData objects

Defined on line: 1870

Called in

getProductRequiredArchitectures

Return a hash ref of strings indicating the required architectures

Defined on line: 1884

Called in

getProductSourcePackages

Return an array ref of ProductPackageData objects

Defined on line: 1909

Called in

getProducts

Return an array ref containing ProductData objects

Defined on line: 1898

Called in

getProfiles

Return an array ref of ProfileData objects available for this image

Defined on line: 1923

Called in

getRepositories

Return an array reference of KIWIXMLRepositories objects that are specified to be part of the current profile(s)

Defined on line: 1967

getSingleInstSourceSatSolvable

Missing

Defined on line: 5727

Called in

getSplitConfig

Return a SplitData object for the configuration of the current build type

Defined on line: 1987

Called in

getSystemDiskConfig

Return a SystemdiskData object for the configuration of the current build type

Defined on line: 1999

Called in

getTestSuitePackages

Return an array ref containing PackageData objects for the packages that should be used in a testsuite run.

Defined on line: 1388

Called in

getToolsToKeep

Return an array ref containing StripData objects for the current selected build profile(s)

Defined on line: 2011

getType

Return a TypeDataObject for the given type if found in the active profiles.

Defined on line: 2023

getUsers

Return a reference to an array holding UserData objects

Defined on line: 2055

Called in

getVMachineConfig

Return a VMachineData object for the virtual machine configuration of the current build type

Defined on line: 2090

Called in

getVagrantConfig

Return an array ref containing VagrantConfigData objects for the selected build type

Defined on line: 1626

Called in

ignoreRepositories

Ignore all the repositories in the XML file.

Defined on line: 2122

Called in

isArchAllowed

Missing

Defined on line: 5646

isDriverUpdateDisk

Missing

Defined on line: 5676

Called in

new

KIWI XML processor and data store The XML object processes the configuration file and stores that data in the imageConfig hash. The hash is layed out as a data structure that resembles the XML file and allows easy access to the data for the use by other objects. Other objects never get access to the internal structure and can only manipulate data via set methods or retrieve data via get methods. Wherever access to complex information is required the XML object will provide a specific object for this data. The provided object in turn has get and set methods to access the data. internal data structure this = { availableProfiles = ('',....) defaultType = { machine = KIWIXMLVMachineData oemconfig = KIWIXMLOEMConfigData vagrantconfig = (KIWIXMLVagrantConfigData,...) pxeconfig = (KIWIXMLPXEDeployConfigData,...) pxedeploy = KIWIXMLPXEDeployData split = KIWIXMLSplitData systemdisk = KIWIXMLSystemdiskData type = KIWIXMLTypeData }, selectedProfiles = ('',....,'kiwi_default') selectedType = { machine = KIWIXMLVMachineData oemconfig = KIWIXMLOEMConfigData vagrantconfig = (KIWIXMLVagrantConfigData,...) pxeconfig = (KIWIXMLPXEDeployConfigData,...) pxedeploy = KIWIXMLPXEDeployData split = KIWIXMLSplitData systemdisk = KIWIXMLSystemdiskData type = KIWIXMLTypeData }, imageConfig = { description = KIWIXMLDescriptionData displayName = '' imageName = '' productSettings = { dudArches = ('',...) reqArches = ('',...) options = KIWIXMLProductOptionsData architectures = (KIWIXMLProductArchitectureData,... ) dudInstSysPkgs = (KIWIXMLProductPackageData,... ) dudModulePkgs = (KIWIXMLProductPackageData,... ) dudPkgs = (KIWIXMLProductPackageData,... ) instRepos = (KIWIXMLInstRepositoryData,... ) metaChroots = (KIWIXMLProductMetaChrootData,...) metaFiles = (KIWIXMLProductMetaFileData,...) metaPkgs = (KIWIXMLProductPackageData,... ) prodPkgs = (KIWIXMLProductPackageData,...) } [+] = { installOpt = '' archives = (KIWIXMLPackageArchiveData,...) bootArchives = (KIWIXMLPackageArchiveData,...) profInfo = KIWIXMLProfileData repoData = (KIWIXMLRepositoryData,...) bootDelPkgs = (KIWIXMLPackageData, ...) bootPkgs = (KIWIXMLPackageData, ...) bootPkgsCollect = (KIWIXMLPackageCollectData,...) bootStrapPckgs = (KIWIXMLPackageData, ...) TestSuitePckgs = (KIWIXMLPackageData, ...) delPkgs = (KIWIXMLPackageData, ...) drivers = (KIWIXMLDriverData, ...) ignorePkgs = (KIWIXMLPackageData, ...) keepLibs = (KIWIXMLStripData,...) keepTools = (KIWIXMLStripData,...) pkgs = (KIWIXMLPackageData, ...) pkgsCollect = (KIWIXMLPackageCollectData,...) products = (KIWIXMLPackageProductData,...) stripDelete = (KIWIXMLStripData,...) [+] { archives = (KIWIXMLPackageArchiveData,...) bootArchives = (KIWIXMLPackageArchiveData,...) bootDelPkgs = (KIWIXMLPackageData, ...) bootPkgs = (KIWIXMLPackageData, ...) bootPkgsCollect = (KIWIXMLPackageCollectData,...) bootStrapPckgs = (KIWIXMLPackageData, ...) TestSuitePckgs = (KIWIXMLPackageData, ...) delPkgs = (KIWIXMLPackageData, ...) drivers = (KIWIXMLDriverData, ...) ignorePkgs = (KIWIXMLPackageData, ...) keepLibs = (KIWIXMLStripData,...) keepTools = (KIWIXMLStripData,...) pkgs = (KIWIXMLPackageData, ...) pkgsCollect = (KIWIXMLPackageCollectData,...) products = (KIWIXMLPackageProductData,...) stripDelete = (KIWIXMLStripData,...) } preferences = { bootloader_theme = '' bootsplash_theme = '' defaultdestination = '' defaultprebuilt = '' defaultroot = '' hwclock = '' keymap = '' locale = '' partitioner = '' packagemanager = '' rpm_check_signatures = '' rpm_excludedocs = '' rpm_force = '' showlicense = '' timezone = '' types = '' version types { defaultType = '' [+] { machine = KIWIXMLVMachineData oemconfig = KIWIXMLOEMConfigData vagrantconfig = (KIWIXMLVagrantConfigData,...) pxeconfig = (KIWIXMLPXEDeployConfigData,...) pxedeploy = KIWIXMLPXEDeployData split = KIWIXMLSplitData systemdisk = KIWIXMLSystemdiskData type = KIWIXMLTypeData } } } [+] { archives = (KIWIXMLPackageArchiveData,....) [+] { archives = (KIWIXMLPackageArchiveData,...) bootArchives = (KIWIXMLPackageArchiveData,...) bootDelPkgs = (KIWIXMLPackageData,...) bootPkgs = (KIWIXMLPackageData,...) bootPkgsCollect = (KIWIXMLPackageCollectData,...) drivers = (KIWIXMLDriverData) ignorePkgs = (KIWIXMLPackageData,...) pkgs = (KIWIXMLPackageData,...) pkgsCollect = (KIWIXMLPackageCollectData) products = (KIWIXMLPackageProductData,...) } bootArchives = (KIWIXMLPackageArchiveData,...) bootDelPkgs = (KIWIXMLPackageData,...) bootPkgs = (KIWIXMLPackageData,...) bootPkgsCollect = (KIWIXMLPackageCollectData,...) drivers = (KIWIXMLPackageCollectData,...) ignorePkgs = (KIWIXMLPackageData,...) pkgs = (KIWIXMLPackageData,...) pkgsCollect = (KIWIXMLPackageCollectData,...) products = (KIWIXMLPackageCollectData,...) } users = (KIWIXMLUserData,...) } } }

Defined on line: 83

Called in

setArch

Set the architecture to use to retrieve information

Defined on line: 5626

setBootProfiles

Missing

Defined on line: 5594

Called in

setBuildType

Set the type to be used as the build type

Defined on line: 2146

Called in

setDescriptionInfo

Set the description information for this configuration

Defined on line: 2187

setImageDisplayName

Set the display name used for the boot menu

Defined on line: 1547

Called in

setOEMConfig

Store a new OEMConfigData object for the selected build type

Defined on line: 1649

Called in

setPackagesToDelete

set new list of PackageData objects for the packages that should be deleted.

Defined on line: 1739

Called in

setPreferences

Set the preferences for the currently selected profiles. We divide each setting to the profile where it is already defined. If a setting is not defined we set the value on the default profile. If I build profiles A, B, and C and am given preferences to set this method will set, for example the bootloader_theme in the profile where the bootloader_theme is defined, A, B, or C or in the default profile if not defined in any of the other profiles.

Defined on line: 2209

Called in

setRepository

Overwrite the first repository marked as replaceable for the currently active profiles, the search starts with the default profile

Defined on line: 2271

Called in

setSelectionProfileNames

Set the information about which profiles to use for data access, if no argument is given set to the default profile(s)

Defined on line: 2331

Called in

setVMachineConfig

Store a new VMachineData object

Defined on line: 2102

Called in

updateType

Modify the type that is currently the build type

Defined on line: 2373

Called in

writeXML

Write the configuration to the given path Writes the XML in formated format

Defined on line: 2401

Called in

__addDefaultSplitNode

if no split section is setup we add a default section from the contents of the KIWISplit.txt file and apply it to the split types

Defined on line: 6152

Called in

__clearInstallData

Clear the given install data object in the proper location in the data structure.

Defined on line: 5352

Called in

__collectBootStrapPackagesData

Collect and coalesce data for the

Defined on line: 2684

Called in

__collectDefaultData

Collect data for the default profile for the given storage location in the data strcuture

Defined on line: 2695

Called in

__collectDeletePackagesData

Collect and coalesce data for the

Defined on line: 2744

Called in

__collectDriverData

Collect and coalesce data for the list

Defined on line: 2755

Called in

__collectPackagesData

Collect and coalesce data for the list

Defined on line: 2766

Called in

__collectStripData

Collect strip data for the given access pattern

Defined on line: 2812

Called in

__collectXMLListData

Collect and coalesce data that is part of a list in XML Items to be collected must have a getName method.

Defined on line: 2832

Called in

__convertSizeStrToMBVal

Convert a given size string that contains M or G into a value that is a representation in MB.

Defined on line: 2922

Called in

__createOEMConfig

Return a ref to a hash containing the configuration for of the given XML:ELEMENT object. Build a data structure that matches the structure defined in KIWIXMLOEMConfigData

Defined on line: 2980

Called in

__createPXEDeployConfig

Return a KIWIXMLPXEDeployData object created from the information in the element of the given XML:ELEMENT object.

Defined on line: 3167

Called in

__createPXEDeployConfigData

Return an array ref to an array containing KIWIXMLPXEDeployConfigData objects. Created from the information in the element of the given XML:ELEMENT object.

Defined on line: 3223

Called in

__createPackageCollectionDataXML

Add data from a collection to the given string

Defined on line: 3049

Called in

__createProductOptions

Return a KIWIXMLProductOptionsData object created from the data in the given node.

Defined on line: 3121

Called in

__createSplitData

Return a ref to a hash containing the configuration for of the given XML:ELEMENT object. Build a data structure that matches the structure defined in KIWIXMLSplitData

Defined on line: 3265

Called in

__createSystemDiskData

Return a ref to a hash containing the configuration for of the given XML:ELEMENT object. Build a data structure that matches the structure defined in KIWIXMLSystemdiskData

Defined on line: 3343

Called in

__createVMachineConfig

Return a ref to a hash that contains the configuration data for the element and it's children for the given XML:ELEMENT object

Defined on line: 3400

Called in

__createVagrantConfig

Return a ref to a hash that contains the configuration data for the elements and it's children for the given XML:ELEMENT object

Defined on line: 2948

Called in

__dumpInternalXMLDescription

return the contents of the imageConfig data structure in a readable format

Defined on line: 3488

__genDUDInstSysPkgsArray

Return a ref to an array containing ProductPackageData objects created from the children of the data of the XML from the given node.

Defined on line: 3505

Called in

__genDUDModulePkgsArray

Return a ref to an array containing ProductPackageData objects created from the children of the data of the XML from the given node.

Defined on line: 3528

Called in

__genDUDPkgsArray

Return a ref to an array containing ProductPackageData objects created from the children of the data of the XML from the given node.

Defined on line: 3551

Called in

__genInstRepoArray

Return a ref to an array containing InstRepositoryData objects created from the data of the XML from the given node.

Defined on line: 3574

Called in

__genMetadataChrootArray

Return a ref to an array containing ProductMetaChrootData objects created from the data of the XML from the given node.

Defined on line: 3610

Called in

__genMetadataFileArray{

Return a ref to an array containing ProductMetaFileData objects created from the data of the XML from the given node.

Defined on line: 3641

__genMetadataPkgsArray

Return a ref to an array containing ProductPackageData objects created from the data of the XML from the given node.

Defined on line: 3673

Called in

__genProductArchitectureArray

Return a ref to an array containing ProductArchitectureData objects created from the data of the XML from the given node.

Defined on line: 3711

Called in

__genProductPackagesArray

Return a ref to an array containing ProductPackageData objects created from the data of the XML from the given node.

Defined on line: 3746

Called in

__genProductReqArchHash

Get the architecture list used for building up an installation source tree

Defined on line: 3767

Called in

__genRepoPackagesArray

Return a ref to an array containing ProductPackageData objects created from the children of the given node.

Defined on line: 3812

Called in

__genTypeHash

Return a ref to a hash keyed by the image type values for all definitions that are children of the given XML:ELEMENT object Build a data structure that matches the structure defined in KIWIXMLTypeData

Defined on line: 3848

Called in

__getChildNodeTextValue

Return the value of the node identified by the given name as text.

Defined on line: 4001

Called in

__getEntryPath

Return the position in the imageConfig structure where install data objects shold be stored. Install data objects are children of the or elements

Defined on line: 4019

Called in

__getInstallData

Return a ref to an array containing objects accumulated across the image config data structure for the given accessID.

Defined on line: 4080

Called in

__getPreferencesXMLElement

Return a complete preferences element for the given profile name

Defined on line: 4157

Called in

__getProfsToModify

Given an array ref, the keyword "default", or no argument generate an array of profile names

Defined on line: 4231

Called in

__getSchemaVersion

Return the schema version extracted from KIWISchema.rnc

Defined on line: 4275

Called in

__getTypeNamesForProfs

Retun an array ref containing names of the configured types for the given profile names.

Defined on line: 4300

Called in

__getVMConfigOpts

Extract the information from the XML and return all options in a list

Defined on line: 6225

__hasDefaultProfName

Check whether the default profile name "kiwi_default" is in the provided array ref of strings

Defined on line: 6244

Called in

__mergePreferenceData

Merge two hashes that represent data into one. Expecting two hash refs as arguments and return a hashref to the merged data. If both hashes have definitions for the same data issues an error.

Defined on line: 4340

Called in

__mergeUsers

Merge the given UserData objects. The data from the second user passed is subsumed by the first user object.

Defined on line: 4428

Called in

__populateArchiveInfo

Populate the imageConfig member with the information from elements from

Defined on line: 4454

Called in

__populateDescriptionInfo

Populate the imageConfig member with the description data from the XML file.

Defined on line: 4506

Called in

__populateDriverInfo

Populate the imageConfig member with the drivers data from the XML file.

Defined on line: 4640

Called in

__populateIgnorePackageInfo

Populate the imageConfig member with the information from

Defined on line: 4686

Called in

__populateInstSource

Populate the imageConfig member with the product data provided with the element and its children from the XML file.

Defined on line: 4541

Called in

__populatePackageCollectionInfo

Populate the imageConfig member with the information from

Defined on line: 4814

Called in

__populatePackageInfo

Populate the imageConfig member with the information from

Defined on line: 4730

Called in

__populatePackageProductInfo

Populate the imageConfig member with the information from

Defined on line: 4867

Called in

__populatePreferenceInfo

Populate the imageConfig member with the preferences data from the XML file.

Defined on line: 4913

Called in

__populateProfileInfo

Populate the imageConfig member with the profile data from the XML file.

Defined on line: 5033

Called in

__populateRepositoryInfo

Populate the imageConfig member with the repository data from the XML file.

Defined on line: 5098

Called in

__populateStripInfo

Populate the imageConfig member with the strip data from the XML file.

Defined on line: 5155

Called in

__populateUserInfo

Populate the imageConfig member with the user data from the XML file.

Defined on line: 5212

Called in

__resolveArchitecture

Missing

Defined on line: 6279

Called in

__resolveLink

Missing

Defined on line: 6263

Called in

__setDefaultBuildType

Set the default built type, which upon object construction is also the the selected built type. The default built type is the first specification processed or the one type marked with primary="true" across all the selected profiles. Unless a type is marked primary, the default type of the default profile always wins. The default type is a ref to a hash that is set as the default type as differentiation by name is not sufficient, as multiple profiles my have the same image type definition, which is valid as long as those profiles are not processed together.

Defined on line: 5275

Called in

__storeInstallData

Store the given install data object in the proper location in the data structure. Install data objects are objects of children of the or elements. If the object was stored, return the object If the object was already present return 1

Defined on line: 5387

Called in

__verifyAddInstallDataArgs

Verify the arguments given to any of the add* methods that handle image installation data.

Defined on line: 5455

Called in

__verifyProfNames

Verify that the profile names in the given array ref are available, if not print the given msg substituting PROF_NAME in the message with the name that is in violation.

Defined on line: 5540

Called in