1. AddOnCreator

1.1. Summary of Module Globals

List of Global Functions

List of Global Variables

  • add_on_products - list of all configured AddOn products

  • bootable - if final Add-On should be bootable (feature not implemented)

  • clone - if we have 'source add-on' to base the new one on

  • content - variables from content file + their description

  • current_product - map of the Add-On product currently in use

  • generate_descriptions - if the descriptions of packages should be generated (false have only sense when cloning where they could be read from description files of cloned product)

  • import_path - path to directory with existing product (which is being cloned)

  • modified - Data was modified?

1.2. Global Functions

1.2.1. BuildAddOn

Write all add-on-creator settings

Return value

  • boolean - true on success

1.2.2. CommitCurrentProduct

save the data with current configuration into global list + reset the current product map

Return value

  • void

1.2.3. CopyRPMs

Copy the packages from the source directory to target

Function parameters

  • string in_path

  • string base_path

Return value

  • boolean - success

1.2.4. CreateAddOnStructure

Create the directory structure of the Add-On

Function parameters

  • string base_path

Return value

  • boolean - success

1.2.5. CreateDirectoryYaSTFiles

Create directory.yast files (the last step)

Function parameters

  • string base_path

Return value

  • boolean - success

1.2.6. CreateISOImage

Create an ISO image of the product

Function parameters

  • string dir_path

  • string iso_p

  • string name

Return value

  • boolean

1.2.7. CreateMD5SUMS

Create MD5SUMS files

Function parameters

  • string base_path

Return value

  • boolean - success

1.2.8. Export

Export the settings about current Add-On product

Return value

  • map

1.2.9. GenerateArchiveFiles

Generate ARCHIVES.gz, INDEX.gz and ls-lR.gz

Function parameters

  • string base_path

Return value

  • boolean

1.2.10. GenerateDirectories

generate the paths of media, data and description dirs

Function parameters

  • string base_path

Return value

  • void

1.2.11. GenerateGPGKey

Generate the key pair

Function parameters

  • map<string,string> data

Return value

  • string

1.2.12. GeneratePackageDescriptions

Generate the package descriptions using create_package_descr

Return value

  • boolean

1.2.13. ImportExistingProduct

import the data from existing add-on

Function parameters

  • string dir_path

Return value

  • boolean

1.2.14. Modified

Data was modified?

Return value

  • boolean - true if modified

1.2.15. PrepareBuild

prepare the data of current product for a build (neccessary because input packages could get changed)

Return value

  • boolean

1.2.16. Read

Initialize the settings for add-on-creator

Return value

  • boolean - true on success

1.2.17. ReadPatternsFile

read all the patterns defined in given file

Function parameters

  • string file_path

Return value

  • list<map> - of pattern maps

1.2.18. ResetCurrentProduct

Reset all settings related to current product

Return value

  • void

1.2.19. SignAddOn

Sign the add-on

Function parameters

  • string base_path

  • string key

Return value

  • boolean

1.2.20. UpdateContentMap

Take list of content-file data and update global content_map. If argument is empty, global 'content' list is used as an input.

Function parameters

  • list<map> content_list

Return value

  • map<string,string>

1.2.21. Write

Write all AddOn products configurations

Return value

  • boolean

1.2.22. WriteContentFile

Write the content file

Function parameters

  • string base_path

  • list<map> content_data

Return value

  • boolean - success

1.2.23. WriteLicensesFiles

Write the text of available licenses to correct places

Function parameters

  • string descr_path

  • string base_path

  • map<string,string> files

Return value

  • boolean

1.2.24. WriteMediaFiles

Write the media.n/media files

Function parameters

  • string base_path

  • list<string> m_files

  • string next

Return value

  • boolean - success

1.2.25. WritePackageDescriptions

Write the package descriptions edited by user

Function parameters

  • string descr_path

  • map descr

Return value

  • boolean

1.2.26. WritePatchesFiles

Create the patches files

Function parameters

  • string base_path

  • list<string> p_files

Return value

  • boolean - success

1.2.27. WritePatterns

Write all files with patterns definitions

Function parameters

  • string descr_path

  • string base_path

Return value

  • boolean

1.2.28. WriteProductsFiles

Create the products file FIXME editor - see ExpertSettingsDialog3

Function parameters

  • string base_path

  • list<string> p_files

Return value

  • boolean - success

1.2.29. WriteStringFiles

Write the readme/COPYING/COPYRIGHT... files in base_path

Function parameters

  • string base_path

  • map<string,string> files

Return value

  • boolean - success

1.3. Global Variables

1.3.1. add_on_products

list of all configured AddOn products

1.3.2. bootable

if final Add-On should be bootable (feature not implemented)

1.3.3. clone

if we have 'source add-on' to base the new one on

1.3.4. content

variables from content file + their description

1.3.5. current_product

map of the Add-On product currently in use

1.3.6. generate_descriptions

if the descriptions of packages should be generated (false have only sense when cloning where they could be read from description files of cloned product)

1.3.7. import_path

path to directory with existing product (which is being cloned)

1.3.8. modified

Data was modified?

1.4. Module Requirements

1.4.1. Module Imports

  • Arch
  • Directory
  • FileUtils
  • Label
  • Mode
  • Package
  • PackageSystem
  • PackagesDescr
  • Popup
  • Progress
  • Report
  • String

1.4.2. Module Includes