Attachment 8907 Details for Bug 20074 – Patch to add POD documentation for new partition table write API (v2)

[patch] Patch to add POD documentation for new partition table write API (v2)

0001-Document-new-partition-table-object-API-used-when-wr.patch (text/plain), 1.52 KB, created by Thierry Vignaud on 2017-01-30 12:31:35 CET

(hide)

Description:

Filename:

MIME Type:

Creator: Thierry Vignaud

Created: 2017-01-30 12:31:35 CET

Size: 1.52 KB

patch

obsolete

>From 530a8c9733f779430aab00d57a4f6ba4cfd10625 Mon Sep 17 00:00:00 2001
>From: Martin Whitaker <mageia@martin-whitaker.me.uk>
>Date: Sat, 28 Jan 2017 17:16:36 +0000
>Subject: [PATCH] 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(+)
>
>diff --git a/perl-install/partition_table.pm b/perl-install/partition_table.pm
>index 76da83b..955a71a 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 {
>-- 
>2.10.2
>

From 530a8c9733f779430aab00d57a4f6ba4cfd10625 Mon Sep 17 00:00:00 2001
From: Martin Whitaker <mageia@martin-whitaker.me.uk>
Date: Sat, 28 Jan 2017 17:16:36 +0000
Subject: [PATCH] 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(+)

diff --git a/perl-install/partition_table.pm b/perl-install/partition_table.pm
index 76da83b..955a71a 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 {
-- 
2.10.2

Actions: View | Diff

Attachments on bug 20074: 8880 | 8881 | 8882 | 8883 | 8901 | 8906 | 8907 | 8908 | 8909 | 8926 | 8927 | 8972