whew! docs finished. 3.00 beta is DONE!
This commit is contained in:
43
docs/manual/dev/functions/BUILD.adoc
Normal file
43
docs/manual/dev/functions/BUILD.adoc
Normal file
@@ -0,0 +1,43 @@
|
||||
=== `build.py`
|
||||
This is responsible for building the "full" ISO, building UEFI support, etc.
|
||||
|
||||
==== genImg(_conf_)
|
||||
This function builds the http://tldp.org/HOWTO/SquashFS-HOWTO/creatingandusing.html[squashed filesystem^] images and, <<code_gpg_code,if requested>>, signs them.
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
==== genUEFI(_build_, _bdisk_)
|
||||
This function builds UEFI support for the ISO files. Returns the path of an embedded EFI bootable binary/ESP image.
|
||||
|
||||
===== build
|
||||
The <<code_build_code,build section>> of the configuration.
|
||||
|
||||
===== bdisk
|
||||
The <<code_bdisk_code,bdisk section>> of the configuration.
|
||||
|
||||
==== genISO(_conf_)
|
||||
Builds the full ISO image(s). Returns a dictionary of information about the built ISO file (see <<iso>>).
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
==== displayStats(_iso_)
|
||||
Parses the output of e.g. <<geniso_em_conf_em,genISO()>> and displays in a summary useful to the end-user.
|
||||
|
||||
===== iso
|
||||
A dictionary of information about the ISO file. This is typically:
|
||||
|
||||
{'iso':
|
||||
{'name':<'Main' for the full ISO, 'Mini' for the mini ISO, etc.>},
|
||||
{<name>:
|
||||
'sha':<SHA256 sum of ISO file>,
|
||||
'file':<full/absolute path to ISO file>,
|
||||
'size':<size, in "humanized" format (e.g. #GB, #MB, etc.)>,
|
||||
'type':<Full or Mini>,
|
||||
'fmt':<human readable ISO type. e.g. Hybrid for an image that can be burned directly to a disk via dd or burned to optical media>
|
||||
}
|
||||
}
|
||||
|
||||
==== cleanUp()
|
||||
Currently a no-op; this function is reserved for future usage to cleanup the build process automatically.
|
||||
Reference in New Issue
Block a user