diff options
author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-02-25 11:21:04 +0000 |
---|---|---|
committer | Baserock Gerrit <gerrit@baserock.org> | 2016-02-25 17:41:34 +0000 |
commit | a41cbe28a3c8f5aa263206776d0891debb9d6fa2 (patch) | |
tree | c76d3b0e13bf507d86ff1d01d7a2366f24e646ae /extensions/writeexts.py | |
parent | 35562686174910752468000e15762c67e44db973 (diff) | |
download | definitions-a41cbe28a3c8f5aa263206776d0891debb9d6fa2.tar.gz |
writeexts: Clarify a few docstrings
Change-Id: I742825726280656d5834817c8a0b496fa6aedaae
Diffstat (limited to 'extensions/writeexts.py')
-rw-r--r-- | extensions/writeexts.py | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/extensions/writeexts.py b/extensions/writeexts.py index 16d05664..d424be3b 100644 --- a/extensions/writeexts.py +++ b/extensions/writeexts.py @@ -278,7 +278,7 @@ class WriteExtension(Extension): self.create_partitioned_system(temp_root, location) else: self.format_btrfs(location) - self.create_system(temp_root, location) + self.create_unpartitioned_system(temp_root, location) @contextlib.contextmanager def created_disk_image(self, location): @@ -299,7 +299,13 @@ class WriteExtension(Extension): sys.stderr.write('Error creating disk image') raise - def create_system(self, temp_root, raw_disk): + def create_unpartitioned_system(self, temp_root, raw_disk): + '''Deploy a bootable Baserock system within a single Btrfs filesystem. + + Called if USE_PARTITIONING=no (the default) is set in the deployment + options. + + ''' with self.mount(raw_disk) as mp: try: self.create_versioned_layout(mp, version_label='factory') @@ -466,6 +472,13 @@ class WriteExtension(Extension): rootfs_uuid, device=None): '''Separate base OS versions from state using subvolumes. + The 'device' parameter should be a pyfdisk.Device instance, + as returned by partitioning.do_partitioning(), that describes the + partition layout of the target device. This is used to set up + mountpoints in the root partition for the other partitions. + If no 'device' instance is passed, no mountpoints are set up in the + rootfs. + ''' version_root = os.path.join(mountpoint, 'systems', version_label) state_root = os.path.join(mountpoint, 'state') @@ -942,8 +955,11 @@ class WriteExtension(Extension): raise def create_partitioned_system(self, temp_root, location): - '''Create a Baserock system in a partitioned disk image or device''' + '''Deploy a bootable Baserock system with a custom partition layout. + + Called if USE_PARTITIONING=yes is set in the deployment options. + ''' part_spec = os.environ.get('PARTITION_FILE', 'partitioning/default') disk_size = self.get_disk_size() |