Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disk: nicer formatting for NewPartitionTable docstring #1040

Merged
merged 1 commit into from
Nov 14, 2024
Merged

disk: nicer formatting for NewPartitionTable docstring #1040

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions pkg/disk/partition_table.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,17 @@ const (
//
// Partitioning modes: The mode controls how the partition table is modified.
//
// - Raw will not convert any partition to LVM or Btrfs.
// - Raw will not convert any partition to LVM or Btrfs.
// - LVM will convert the partition that contains the root mountpoint '/' to an
//
// - LVM will convert the partition that contains the root mountpoint '/' to an
// LVM Volume Group and create a root Logical Volume. Any extra mountpoints,
// except /boot, will be added to the Volume Group as new Logical Volumes.
//
// - Btrfs will convert the partition that contains the root mountpoint '/' to
// a Btrfs volume and create a root subvolume. Any extra mountpoints, except
// /boot, will be added to the Btrfs volume as new Btrfs subvolumes.
//
// - AutoLVM is the default mode and will convert a raw partition table to an
// LVM-based one if and only if new mountpoints are added.
// - Btrfs will convert the partition that contains the root mountpoint '/' to
// a Btrfs volume and create a root subvolume. Any extra mountpoints, except
// /boot, will be added to the Btrfs volume as new Btrfs subvolumes.
// - AutoLVM is the default mode and will convert a raw partition table to an
// LVM-based one if and only if new mountpoints are added.
//
// Directory sizes: The requiredSizes argument defines a map of minimum sizes
// for specific directories. These indirectly control the minimum sizes of
Expand All @@ -83,7 +82,7 @@ const (
// most cases, this translates to a requirement of 3 GiB for the root
// partition, Logical Volume, or Btrfs subvolume.
//
// General principles:
// # General principles:
//
// Desired sizes for partitions, partition tables, volumes, directories, etc,
// are always treated as minimum sizes. This means that very often the full
Expand Down Expand Up @@ -774,6 +773,7 @@ func (pt *PartitionTable) ensureBtrfs() error {
if err != nil {
return err
}

btrfs := &Btrfs{
Label: "root",
Subvolumes: []BtrfsSubvolume{
Expand Down
Loading