From c093539d9a443f5192888f3a4f7d019613f58384 Mon Sep 17 00:00:00 2001
From: Richard Stephens <richard@richst.dev>
Date: Thu, 29 Feb 2024 16:04:53 +0100
Subject: [PATCH] docs: document that pmbr shouldn't be used unless nedded

---
 src/lib.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index f7cb050..62304b7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1246,6 +1246,10 @@ impl GPT {
     /// MBR partition table is marked as bootable. Some legacy BIOS systems do not consider a disk
     /// to be bootable if there isn't an MBR partition marked as bootable in the MBR partition
     /// table.
+    ///
+    /// <div class="warning">Some systems will not consider a disk to be bootable in UEFI mode
+    /// if the pMBR is marked as bootable, so this should only be used if booting on legacy BIOS
+    /// systems is a requirement.</div>
     pub fn write_bootable_protective_mbr_into<W: ?Sized>(
         mut writer: &mut W,
         sector_size: u64,