Skip to content

Commit 4f6f6bb

Browse files
committed
Minor docs improvements
1 parent bd2a59d commit 4f6f6bb

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/lib.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,11 @@ pub fn create_bios_disk_image(
123123
Ok(())
124124
}
125125

126-
/// Prepare a folder for use with booting over UEFI_PXE. The dhcp server should
127-
/// have the filename option set to `bootloader`.
126+
/// Prepare a folder for use with booting over UEFI_PXE.
127+
///
128+
/// This places the bootloader executable under the path "bootloader". The
129+
/// DHCP server should set the filename option to that path, otherwise the
130+
/// bootloader won't be found.
128131
pub fn create_uefi_pxe_tftp_folder(kernel_binary: &Path, out_path: &Path) -> anyhow::Result<()> {
129132
let bootloader_path = Path::new(env!("UEFI_BOOTLOADER_PATH"));
130133

0 commit comments

Comments
 (0)