rename option to default-target

also document the option

CHANGELOG.md

@@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- #624 - Add `build.default-target`
 - #670 - Use serde for deserialization of Cross.toml
 - Change rust edition to 2021 and bump MSRV for the cross binary to 1.58.1
 - #654 - Use color-eyre for error reporting

docs/cross_toml.md

@@ -6,6 +6,7 @@ The `build` key allows you to set global variables, e.g.:
 ```toml
 [build]
 xargo = true
+default-target = "x86_64-unknown-linux-gnu"
 ```
 
 # `build.env`

src/config.rs

@@ -189,7 +189,9 @@ impl Config {
         if let Some(env_value) = self.env.target() {
             return Some(Target::from(&env_value, target_list));
         }
-        self.toml.as_ref().map_or(None, |t| t.target(target_list))
+        self.toml
+            .as_ref()
+            .and_then(|t| t.default_target(target_list))
     }
 
     fn sum_of_env_toml_values(
@@ -424,7 +426,7 @@ mod tests {
 
         static TOML_DEFAULT_TARGET: &str = r#"
     [build]
-    target = "aarch64-unknown-linux-gnu"
+    default-target = "aarch64-unknown-linux-gnu"
     "#;
     }
 }

src/cross_toml.rs

@@ -16,10 +16,11 @@ pub struct CrossBuildEnvConfig {
 
 /// Build configuration
 #[derive(Debug, Deserialize, PartialEq, Default)]
+#[serde(rename_all = "kebab-case")]
 pub struct CrossBuildConfig {
     env: Option<CrossBuildEnvConfig>,
     xargo: Option<bool>,
-    target: Option<String>,
+    default_target: Option<String>,
 }
 
 /// Target configuration
@@ -92,8 +93,11 @@ impl CrossToml {
     }
 
     /// Returns the default target to build,
-    pub fn target(&self, target_list: &TargetList) -> Option<Target> {
-        self.build.as_ref().and_then(|b| b.target.as_ref()).map(|t| Target::from(t, target_list))
+    pub fn default_target(&self, target_list: &TargetList) -> Option<Target> {
+        self.build
+            .as_ref()
+            .and_then(|b| b.default_target.as_ref())
+            .map(|t| Target::from(t, target_list))
     }
 
     /// Returns a reference to the [`CrossTargetConfig`] of a specific `target`
@@ -134,7 +138,7 @@ mod tests {
                     passthrough: vec!["VAR1".to_string(), "VAR2".to_string()],
                 }),
                 xargo: Some(true),
-                target: None,
+                default_target: None,
             }),
         };