whew! docs finished. 3.00 beta is DONE!
This commit is contained in:
52
docs/manual/dev/functions/PREP.adoc
Normal file
52
docs/manual/dev/functions/PREP.adoc
Normal file
@@ -0,0 +1,52 @@
|
||||
=== `prep.py`
|
||||
This contains functions that download the base tarball releases, preps them for <<code_bchroot_py_code>>, builds necessary directory structures, and performs the overlay preparations.
|
||||
|
||||
==== dirChk(_conf_)
|
||||
This function creates extra directories if needed.
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
==== downloadTarball(_conf_)
|
||||
This function downloads the tarball (<<code_mirrorfile_code>>) from the <<code_mirror_code>>, and performs verifications (SHA1 and GPG signature <<code_mirrorgpgsig_code,if enabled>>). Returns the full/absolute path to the downloaded tarball.
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
==== unpackTarball(_tarball_path_, _build_, _keep_ = False)
|
||||
This function extracts the tarball downloaded via <<downloadtarball_em_conf_em,downloadTarball()>>.
|
||||
|
||||
===== tarball_path
|
||||
The full/absolute path to the downloaded tarball.
|
||||
|
||||
===== build
|
||||
See <<build>>.
|
||||
|
||||
===== keep
|
||||
`True` or `False`. Whether we should keep the downloaded tarball after unpacking/extracting. If your upstream tarball changes often enough, it's recommended to set this to `False`. However, setting it to `True` can speed up the build process if you're on a slower Internet connection.
|
||||
|
||||
==== buildChroot(_conf_, _keep_ = False)
|
||||
This incorporates <<downloadtarball_em_conf_em,donwloading>> and <<unpacktarball_em_tarball_path_em_em_build_em_em_keep_em_false,extracting>> into one function, as well as applying the <<pre_build_d>> directory (and the <<pre_build_d_2,pre-build.d templates>>).
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
===== keep
|
||||
See <<keep>>.
|
||||
|
||||
==== prepChroot(_conf_)
|
||||
Returns a modified/updated <<build>>. This function:
|
||||
|
||||
. Prepares some variables that <<changing_the_build_process,pre-build.sh>> needs inside the chroot(s)
|
||||
. Builds <<version_info_txt_j2,the VERSION_INFO.txt file>>
|
||||
. Updates the build number
|
||||
. Imports the <<code_mygpgkey_code,signing GPG key>>
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
|
||||
==== postChroot(_conf_)
|
||||
This function applies the <<overlay_2>> directory (and the <<overlay,overlay templates>>).
|
||||
|
||||
===== conf
|
||||
See <<conf>>.
|
||||
Reference in New Issue
Block a user