Proofread the docstrings for the help output

axtloss/rework-partitioning
Michal S 2 years ago committed by Michal
parent 08ce6aa81b
commit 1d5dc7ef33

@ -26,7 +26,7 @@ pub enum Command {
#[clap(name = "genfstab")] #[clap(name = "genfstab")]
GenFstab, GenFstab,
/// Setup timeshift /// Setup Timeshift
#[clap(name = "setup-timeshift")] #[clap(name = "setup-timeshift")]
SetupTimeshift, SetupTimeshift,
@ -37,11 +37,11 @@ pub enum Command {
subcommand: BootloaderSubcommand, subcommand: BootloaderSubcommand,
}, },
/// Set locale stuff /// Set locale
#[clap(name = "locale")] #[clap(name = "locale")]
Locale(LocaleArgs), Locale(LocaleArgs),
/// Set networking stuff /// Set up networking
#[clap(name = "networking")] #[clap(name = "networking")]
Networking(NetworkingArgs), Networking(NetworkingArgs),
@ -56,26 +56,26 @@ pub enum Command {
subcommand: UsersSubcommand, subcommand: UsersSubcommand,
}, },
/// Install the nix package manager /// Install the Nix package manager
#[clap(name = "nix")] #[clap(name = "nix")]
Nix, Nix,
/// Install flatpak and enable flathub /// Install Flatpak and enable FlatHub
#[clap(name = "flatpak")] #[clap(name = "flatpak")]
Flatpak, Flatpak,
/// Setup unakite /// Setup Unakite
#[clap(name = "unakite")] #[clap(name = "unakite")]
Unakite(UnakiteArgs), Unakite(UnakiteArgs),
/// Read jade installation config /// Read Jade installation config
#[clap(name = "config")] #[clap(name = "config")]
Config { Config {
/// The config to read /// The config file to read
config: PathBuf, config: PathBuf,
}, },
/// Install a graphical desktop setup /// Install a graphical desktop
#[clap(name = "desktops")] #[clap(name = "desktops")]
Desktops { Desktops {
/// The desktop setup to use /// The desktop setup to use
@ -115,19 +115,19 @@ pub struct InstallBaseArgs {
#[derive(Debug, Args)] #[derive(Debug, Args)]
pub struct UnakiteArgs { pub struct UnakiteArgs {
/// root device of unakite /// Root device of Unakite
#[clap(long)] #[clap(long)]
pub root: String, pub root: String,
/// root device of crystal /// Root device of Crystal
#[clap(long)] #[clap(long)]
pub oldroot: String, pub oldroot: String,
/// wether it is efi /// Whether the system is an EFI system
#[clap(long)] #[clap(long)]
pub efi: bool, pub efi: bool,
/// boot directory (if not efi) or efi directory (if efi) /// Boot directory (if not EFI), or EFI directory
#[clap(long)] #[clap(long)]
pub efidir: String, pub efidir: String,
/// device of boot device /// Blockdev of boot device
#[clap(long)] #[clap(long)]
pub bootdev: String, pub bootdev: String,
} }
@ -168,14 +168,14 @@ pub enum PartitionMode {
#[derive(Debug, Subcommand)] #[derive(Debug, Subcommand)]
pub enum BootloaderSubcommand { pub enum BootloaderSubcommand {
/// Install grub in efi mode /// Install GRUB in EFI mode
#[clap(name = "grub-efi")] #[clap(name = "grub-efi")]
GrubEfi { GrubEfi {
/// The directory to install the EFI bootloader to /// The directory to install the EFI bootloader to
efidir: PathBuf, efidir: PathBuf,
}, },
/// Install grub in legacy (BIOS) mode /// Install GRUB in legacy (BIOS) mode
#[clap(name = "grub-legacy")] #[clap(name = "grub-legacy")]
GrubLegacy { GrubLegacy {
/// The device to install the bootloader to /// The device to install the bootloader to
@ -200,7 +200,7 @@ pub struct NetworkingArgs {
/// The hostname to assign to the system /// The hostname to assign to the system
pub hostname: String, pub hostname: String,
/// Whether ipv6 should be enabled /// Whether IPv6 loopback should be enabled
#[clap(long)] #[clap(long)]
pub ipv6: bool, pub ipv6: bool,
} }

Loading…
Cancel
Save