Merge #1342

1342: Explain why fallback happened when subcommand is not supported, and fix rustdoc r=Emilgardis a=Emilgardis

Resolves #1341 by adding rustdoc as a supported command. Also adds a explanation when a unsupported subcommand is used.

This also fixes a bug with `--list`


Co-authored-by: Emil Gardström <[email protected]>

.changes/1342.json

@@ -0,0 +1,10 @@
+[
+    {
+        "description": "fix `--list` showing cross commands for the host",
+        "type": "fixed"
+    },
+    {
+        "description": "add `rustdoc` as a supported cargo subcommand",
+        "type": "added"
+    }
+]

src/bin/cross.rs

@@ -17,7 +17,7 @@ pub fn main() -> cross::Result<()> {
 
     let target_list = rustc::target_list(&mut Verbosity::Quiet.into())?;
     let args = cli::parse(&target_list)?;
-    let subcommand = args.subcommand;
+    let subcommand = args.subcommand.clone();
     let mut msg_info = shell::MessageInfo::create(args.verbose, args.quiet, args.color.as_deref())?;
     let status = match cross::run(args, target_list, &mut msg_info)? {
         Some(status) => status,

src/cargo.rs

@@ -7,27 +7,28 @@ use crate::errors::*;
 use crate::extensions::CommandExt;
 use crate::shell::{self, MessageInfo};
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub enum Subcommand {
     Build,
     Check,
     Doc,
-    Other,
     Run,
+    Rustdoc,
     Rustc,
     Test,
     Bench,
     Clippy,
     Metadata,
     List,
     Clean,
+    Other(String),
 }
 
 impl Subcommand {
     #[must_use]
     pub fn needs_docker(self, is_remote: bool) -> bool {
         match self {
-            Subcommand::Other | Subcommand::List => false,
+            Subcommand::Other(_) | Subcommand::List => false,
             Subcommand::Clean if !is_remote => false,
             _ => true,
         }
@@ -58,12 +59,13 @@ impl<'a> From<&'a str> for Subcommand {
             "doc" => Subcommand::Doc,
             "r" | "run" => Subcommand::Run,
             "rustc" => Subcommand::Rustc,
+            "rustdoc" => Subcommand::Rustdoc,
             "t" | "test" => Subcommand::Test,
             "bench" => Subcommand::Bench,
             "clippy" => Subcommand::Clippy,
             "metadata" => Subcommand::Metadata,
             "--list" => Subcommand::List,
-            _ => Subcommand::Other,
+            command => Subcommand::Other(command.to_owned()),
         }
     }
 }

src/cli.rs

@@ -36,7 +36,7 @@ pub fn group_subcommands(stdout: &str) -> (Vec<&str>, Vec<&str>) {
         let first = line.split_whitespace().next();
         if let Some(command) = first {
             match Subcommand::from(command) {
-                Subcommand::Other => host.push(line),
+                Subcommand::Other(_) => host.push(line),
                 _ => cross.push(line),
             }
         }
@@ -55,7 +55,7 @@ pub fn fmt_subcommands(stdout: &str, msg_info: &mut MessageInfo) -> Result<()> {
     }
     if !host.is_empty() {
         msg_info.print("Host Commands:")?;
-        for line in &cross {
+        for line in &host {
             msg_info.print(line)?;
         }
     }

src/lib.rs

@@ -524,6 +524,13 @@ pub fn run(
         ))?;
     }
 
+    if let Some(Subcommand::Other(command)) = &args.subcommand {
+        msg_info.warn(format_args!(
+            "specified cargo subcommand `{command}` is not supported by `cross`."
+        ))?;
+        return Ok(None);
+    }
+
     let host_version_meta = rustc::version_meta()?;
 
     let cwd = std::env::current_dir()?;
@@ -597,6 +604,7 @@ pub fn run(
 
             let needs_docker = args
                 .subcommand
+                .clone()
                 .map_or(false, |sc| sc.needs_docker(is_remote));
             if target.needs_docker() && needs_docker {
                 let paths = docker::DockerPaths::create(
@@ -623,8 +631,14 @@ pub fn run(
                     &options,
                     msg_info,
                 )?;
-                let status = docker::run(options, paths, &filtered_args, args.subcommand, msg_info)
-                    .wrap_err("could not run container")?;
+                let status = docker::run(
+                    options,
+                    paths,
+                    &filtered_args,
+                    args.subcommand.clone(),
+                    msg_info,
+                )
+                .wrap_err("could not run container")?;
                 let needs_host = args.subcommand.map_or(false, |sc| sc.needs_host(is_remote));
                 if !status.success() {
                     warn_on_failure(&target, &toolchain, msg_info)?;
@@ -646,7 +660,10 @@ pub fn install_interpreter_if_needed(
     options: &docker::DockerOptions,
     msg_info: &mut MessageInfo,
 ) -> Result<(), color_eyre::Report> {
-    let needs_interpreter = args.subcommand.map_or(false, |sc| sc.needs_interpreter());
+    let needs_interpreter = args
+        .subcommand
+        .clone()
+        .map_or(false, |sc| sc.needs_interpreter());
 
     if host_version_meta.needs_interpreter()
         && needs_interpreter
@@ -670,6 +687,7 @@ pub fn get_filtered_args(
     let add_libc = |triple: &str| add_libc_version(triple, zig_version.as_deref());
     let mut filtered_args = if args
         .subcommand
+        .clone()
         .map_or(false, |s| !s.needs_target_in_command())
     {
         let mut filtered_args = Vec::new();
@@ -710,7 +728,10 @@ pub fn get_filtered_args(
         args.cargo_args.clone()
     };
 
-    let is_test = args.subcommand.map_or(false, |sc| sc == Subcommand::Test);
+    let is_test = args
+        .subcommand
+        .clone()
+        .map_or(false, |sc| sc == Subcommand::Test);
     if is_test && config.doctests().unwrap_or_default() && is_nightly {
         filtered_args.push("-Zdoctest-xcompile".to_owned());
     }

src/rustup.rs

@@ -299,6 +299,7 @@ pub fn setup_components(
         }
         if args
             .subcommand
+            .clone()
             .map_or(false, |sc| sc == crate::Subcommand::Clippy)
             && !component_is_installed("clippy", toolchain, msg_info)?
         {