Skip to content

Commit 1e2692e

Browse files
committed
eif_build: Clean up doc comment
Line comments starting with /// refer to the item following them, which means the doc comment was actually commenting use std::path::{Path, PathBuf}. Switch to //! which refers to the parent scope the comment lives in (the main.rs file in this case). Also massage the text a bit. Signed-off-by: Sabin Rapan <[email protected]>
1 parent f03ac22 commit 1e2692e

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

eif_build/src/main.rs

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
// Copyright 2019-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4+
//! Simple utility tool for building an EIF file.
5+
//!
6+
//! Example of usage:
7+
//!
8+
//!```sh
9+
//! cargo run -p eif_build --target-dir=~/vmm-build -- --kernel bzImage \
10+
//! --cmdline "reboot=k initrd=0x2000000,3228672 root=/dev/ram0 panic=1 pci=off nomodules \
11+
//! console=ttyS0 i8042.noaux i8042.nomux i8042.nopnp i8042.dumbkbd" \
12+
//! --ramdisk initramfs_x86.txt_part1.cpio.gz \
13+
//! --ramdisk initramfs_x86.txt_part2.cpio.gz \
14+
//! --output eif.bin
15+
//!```
416
#![deny(warnings)]
5-
/// Simple utility tool for building an Eif file
6-
/// cargo run --example eif_build -- --help should be self explanatory.
7-
/// Example of usage:
8-
/// cargo run --example eif_build --target-dir=~/vmm-build -- --kernel bzImage \
9-
/// --cmdline "reboot=k initrd=0x2000000,3228672 root=/dev/ram0 panic=1 pci=off nomodules \
10-
/// console=ttyS0 i8042.noaux i8042.nomux i8042.nopnp i8042.dumbkbd"
11-
/// --ramdisk initramfs_x86.txt_part1.cpio.gz
12-
/// --ramdisk initramfs_x86.txt_part2.cpio.gz
13-
/// --output eif.bin
14-
///
15-
use std::path::{Path, PathBuf};
1617
use aws_nitro_enclaves_image_format::defs::{EifBuildInfo, EifIdentityInfo, EIF_HDR_ARCH_ARM64};
1718
use aws_nitro_enclaves_image_format::utils::identity::parse_custom_metadata;
1819
use aws_nitro_enclaves_image_format::{
@@ -24,6 +25,7 @@ use clap::{Args, Parser, ValueEnum};
2425
use serde_json::json;
2526
use sha2::{Digest, Sha384};
2627
use std::fs::OpenOptions;
28+
use std::path::{Path, PathBuf};
2729

2830
#[allow(non_camel_case_types)]
2931
#[derive(Clone, Debug, ValueEnum)]

0 commit comments

Comments
 (0)