r00t2/bdisk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

documentation check-in...

Browse Source
This commit is contained in:
brent s.
2016-12-30 00:09:24 -05:00
parent 0c9dcfd833
commit 17078f3d1d
7 changed files with 114 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/manual/dev/functions/BCHROOT.adoc Normal file
View File

@@ -0,0 +1,29 @@
=== `bchroot.py`
This file controls creation of the chroots -- the directories in which BDisk builds the actual system that is booted into.
==== chroot(_chrootdir_, _chroot_hostname_, _cmd_ = '`/root/pre-build.sh`')
This function manages mounting the mountpoints for the chroot(s) in preparation for the images of the live media. It also runs <<changing_the_build_process,the inner chroot preparation script>>. Returns `chrootdir` (same as the paramater provided).
===== chrootdir
The directory where the filesystem tree for the chroot lies. Absolute path only.
===== chroot_hostname
The hostname to use for the guest.
NOTE: This paramater may be removed in future versions.
===== cmd
The command to run inside the chroot once all the mountpoints are set up.
==== chrootUnmount(_chrootdir_)
Unmount the mounts set up in <<chroot_em_chrootdir_em_em_chroot_hostname_em_em_cmd_em_root_pre_build_sh,chroot()>>.
===== chrootdir
See <<chrootdir>>.
==== chrootTrim(_build_)
This function performs some cleanup and optimizations to the chroot(s).
===== build
A dictionary of <<code_build_code>>'s values (with some additional keys/values added). See (TODO: link to host.py's config parser).