From 75445cb236238e0203eb3e162c0f7ebcddcceba2 Mon Sep 17 00:00:00 2001 From: Martin Whitaker Date: Sat, 28 Jan 2017 17:16:36 +0000 Subject: Document new partition table object API used when writing partition tables. v2 (tvignaud): enhance doc --- perl-install/partition_table.pm | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'perl-install') diff --git a/perl-install/partition_table.pm b/perl-install/partition_table.pm index 76da83b81..955a71a3f 100644 --- a/perl-install/partition_table.pm +++ b/perl-install/partition_table.pm @@ -462,6 +462,33 @@ sub tell_kernel { Write the partition table +The partition_table_XXX object is expected to provide three functions to +support writing the partition table: + +=over + +=item * start_write() + +start_write() is called once at the beginning to initiate the write operation, + +=item * write() + +write() is then called one or more times (depending on whether there are any +extended partitions), + +=item * end_write(). + +and end_write() is called once to complete the write operation. + +=back + +For partition table types that support extended partitions (e.g. DOS), +start_write() is expected to return a file handle to the raw device which is +then passed to write() and end_write(), allowing the entire table to be written +before closing the raw device. For partition table types that don't support +extended partitions, this is optional, and the entire write operation can be +performed in the single call to write(). + =cut sub write { -- cgit v1.2.1