Update --help output

Author: phil-opp

src/help/build_help.txt

@@ -12,9 +12,9 @@ BUILD_OPTS:
     disk image.
 
 CONFIGURATION:
-    The bootloader and the behavior of `bootimage build` can be configured
-    through a `[package.metadata.bootimage]` table in the `Cargo.toml`. The
-    following options are available to configure the build:
+    The behavior of `bootimage build` can be configured through a
+    `[package.metadata.bootimage]` table in the `Cargo.toml`. The following
+    options are available to configure the build:
 
     [package.metadata.bootimage]
     default-target = ""         This target is used if no `--target` is passed

src/help/cargo_bootimage_help.txt

@@ -0,0 +1,20 @@
+Creates a bootable disk image from a Rust kernel
+
+USAGE:
+    cargo bootimage [BUILD_OPTS]        Create a bootable disk image
+
+    (for other forms of usage see `bootimage --help`)
+
+BUILD_OPTS:
+    Any options are directly passed to `cargo build` (see
+    `cargo build --help` for possible options). After building, a bootloader
+    is downloaded and built, and then combined with the kernel into a bootable
+    disk image.
+
+CONFIGURATION:
+    The behavior of `cargo bootimage` can be configured through a
+    `[package.metadata.bootimage]` table in the `Cargo.toml`. The following
+    options are available to configure the build:
+
+    [package.metadata.bootimage]
+    default-target = ""         This target is used if no `--target` is passed

src/help/help.txt

@@ -5,6 +5,10 @@ USAGE:
     bootimage build [BUILD_OPTS]                Create a bootable disk image
     bootimage run [BUILD_OPTS] -- [RUN_OPTS]    Build and run a disk image
     bootimage test [BUILD_OPTS]                 Runs integration tests
+    bootimage runner EXECUTABLE                 Convert and run an executable
+
+    cargo bootimage [BUILD_OPTS]                Create a bootable disk image
+                                                (equivalent to bootimage build)
 
 For more information about a subcommand run `bootimage [subcommand] --help`.
 

src/help/mod.rs

@@ -2,7 +2,9 @@ use std::process;
 
 const HELP: &str = include_str!("help.txt");
 const BUILD_HELP: &str = include_str!("build_help.txt");
+const CARGO_BOOTIMAGE_HELP: &str = include_str!("cargo_bootimage_help.txt");
 const RUN_HELP: &str = include_str!("run_help.txt");
+const RUNNER_HELP: &str = include_str!("runner_help.txt");
 const TEST_HELP: &str = include_str!("test_help.txt");
 
 pub(crate) fn help() {
@@ -13,10 +15,18 @@ pub(crate) fn build_help() {
     print!("{}", BUILD_HELP);
 }
 
+pub(crate) fn cargo_bootimage_help() {
+    print!("{}", CARGO_BOOTIMAGE_HELP);
+}
+
 pub(crate) fn run_help() {
     print!("{}", RUN_HELP);
 }
 
+pub(crate) fn runner_help() {
+    print!("{}", RUNNER_HELP);
+}
+
 pub(crate) fn test_help() {
     print!("{}", TEST_HELP);
 }

src/help/run_help.txt

@@ -16,6 +16,9 @@ CONFIGURATION:
     following options are available to configure run behavior:
 
     [package.metadata.bootimage]
-    # The command invoked on `bootimage run`
+    # The command invoked on `bootimage run` or `bootimage runner`
     # (the "{}" will be replaced with the path to the bootable disk image)
     run-command = ["qemu-system-x86_64", "-drive", "format=raw,file={}"]
+    # Additional arguments passed to the runner on `bootimage run` or `bootimage runner`
+    # (this is useful when you want to add some arguments to the default QEMU command)
+    run-args = []

src/help/runner_help.txt

@@ -0,0 +1,25 @@
+Creates a bootable disk image from a Rust kernel and launches it in QEMU
+
+USAGE:
+    bootimage runner EXECUTABLE        Convert and run the given EXECUTABLE
+
+    (for other forms of usage see `bootimage --help`)
+
+    This subcommand can be used as a target runner in a `.cargo/config` file:
+    ```
+        [target.'cfg(target_os = "none")']
+        runner = "bootimage runner"
+    ```
+
+CONFIGURATION:
+    The behavior of `bootimage runner` can be configured through a
+    `[package.metadata.bootimage]` table in the `Cargo.toml`. The
+    following options are available to configure run behavior:
+
+    [package.metadata.bootimage]
+    # The command invoked on `bootimage run` or `bootimage runner`
+    # (the "{}" will be replaced with the path to the bootable disk image)
+    run-command = ["qemu-system-x86_64", "-drive", "format=raw,file={}"]
+    # Additional arguments passed to the runner on `bootimage run` or `bootimage runner`
+    # (this is useful when you want to add some arguments to the default QEMU command)
+    run-args = []

src/lib.rs

@@ -67,10 +67,11 @@ pub fn run() -> Result<Option<i32>, ErrorMessage> {
         Command::NoSubcommand => help::no_subcommand(),
         Command::Help => Ok(help::help()).map(none),
         Command::BuildHelp => Ok(help::build_help()).map(none),
+        Command::CargoBootimageHelp => Ok(help::cargo_bootimage_help()).map(none),
         Command::RunHelp => Ok(help::run_help()).map(none),
+        Command::RunnerHelp => Ok(help::runner_help()).map(none),
         Command::TestHelp => Ok(help::test_help()).map(none),
         Command::Version => Ok(println!("bootimage {}", env!("CARGO_PKG_VERSION"))).map(none),
-        Command::RunnerHelp | Command::CargoBootimageHelp => unimplemented!(),
     }
 }