install: add comments: logic in postmarketos-ondev (MR 2008)

Add comments to two functions, that if they are changed, the logic also
needs to be updated in ondev-preapre-internal-storage.sh of
postmarketos-ondev.git.
This commit is contained in:
Oliver Smith 2020-12-19 11:52:08 +01:00 committed by Martijn Braam
parent d9682be771
commit 39ad7246f7
No known key found for this signature in database
GPG key ID: C4280ACB000B060F
2 changed files with 6 additions and 0 deletions

View file

@ -8,6 +8,9 @@ import pmb.chroot
def format_and_mount_boot(args, boot_label):
"""
:param boot_label: label of the root partition (e.g. "pmOS_boot")
When adjusting this function, make sure to also adjust
ondev-prepare-internal-storage.sh in postmarketos-ondev.git!
"""
mountpoint = "/mnt/install/boot"
device = "/dev/installp1"

View file

@ -50,6 +50,9 @@ def partition(args, size_boot, size_reserve):
* /dev/installp2: root (or reserved space)
* /dev/installp3: (root, if reserved space > 0)
When adjusting this function, make sure to also adjust
ondev-prepare-internal-storage.sh in postmarketos-ondev.git!
:param size_boot: size of the boot partition in MiB
:param size_reserve: empty partition between root and boot in MiB (pma#463)
"""