Documentation improvements. Avoid inheriting package_name and label.

Author: philip-alldredge

README.md

@@ -110,23 +110,34 @@ min_sdk_version = 26
 build_targets = [ "armv7-linux-androideabi", "aarch64-linux-android", "i686-linux-android", "x86_64-linux-android" ]
 
 #
-# The following settings can be customized on a per bin/example basis. See multiple_targets example
+# The following value can be customized on a per bin/example basis. See multiple_targets example
+# If a value is not specified for a secondary target, it will inherit the value defined in the `package.metadata.android`
+# section unless otherwise noted.
 #
 
 # The Java package name for your application.
 # Hyphens are converted to underscores.
+# Defaults to rust.<target_name> for binaries. 
+# Defaults to rust.<package_name>.example.<target_name> for examples.
+# For example: for a binary "my_app", the default package name will be "rust.my_app"
+# Secondary targets will not inherit the value defined in the root android configuration.
 package_name = "rust.cargo.apk.advanced"
 
 # The user-friendly name for your app, as displayed in the applications menu.
+# Defaults to the target name
+# Secondary targets will not inherit the value defined in the root android configuration.
 label = "My Android App"
 
-# Path to your application's res/ folder.
+# Path to your application's resources folder.
+# If not specified, resources will not be included in the APK
 res = "path/to/res_folder"
 
 # Virtual path your application's icon for any mipmap level.
+# If not specified, an icon will not be included in the APK.
 icon = "@mipmap/ic_launcher"
 
 # Path to the folder containing your application's assets.
+# If not specified, assets will not be included in the APK
 assets = "path/to/assets_folder"
 
 # If set to true, makes the app run in full-screen, by adding the following line
@@ -135,7 +146,8 @@ assets = "path/to/assets_folder"
 # Defaults to false.
 fullscreen = false
 
-# The maximum supported OpenGL ES version , as claimed by the manifest. Defaults to 2.0.
+# The maximum supported OpenGL ES version , as claimed by the manifest.
+# Defaults to 2.0.
 # See https://developer.android.com/guide/topics/graphics/opengl.html#manifest
 opengles_version_major = 3
 opengles_version_minor = 2

cargo-apk/src/config.rs

@@ -16,6 +16,9 @@ use std::path::PathBuf;
 use toml;
 
 pub struct AndroidConfig {
+    /// Name of the cargo package
+    pub cargo_package_name: String,
+
     /// Path to the manifest
     pub manifest_path: PathBuf,
     /// Path to the root of the Android SDK.
@@ -51,17 +54,19 @@ impl AndroidConfig {
     /// Builds the android target config based on the default target config and the specific target configs defined in the manifest
     pub fn resolve(&self, target: (TargetKind, String)) -> CargoResult<AndroidTargetConfig> {
         let primary_config = self.target_configs.get(&target);
-        let package_name = target.1;
+        let target_name = target.1;
+        let is_default_target = target_name == self.cargo_package_name;
+        let example = target.0 == TargetKind::ExampleBin;
 
         Ok(AndroidTargetConfig {
             package_name: primary_config
                 .and_then(|a| a.package_name.clone())
-                .or_else(|| self.default_target_config.package_name.clone())
-                .unwrap_or_else(|| format!("rust.{}", package_name)),
+                .or_else(|| if is_default_target { self.default_target_config.package_name.clone() } else { None } )
+                .unwrap_or_else(|| if example { format!("rust.{}.example.{}", self.cargo_package_name, target_name) } else { format!("rust.{}", target_name) } ),
             package_label: primary_config
                 .and_then(|a| a.label.clone())
-                .or_else(|| self.default_target_config.label.clone())
-                .unwrap_or_else(|| package_name.clone()),
+                .or_else(||  if is_default_target { self.default_target_config.label.clone() } else { None } )
+                .unwrap_or_else(|| target_name.clone()),
             package_icon: primary_config
                 .and_then(|a| a.icon.clone())
                 .or_else(|| self.default_target_config.icon.clone()),
@@ -333,6 +338,7 @@ pub fn load(
 
     // For the moment some fields of the config are dummies.
     Ok(AndroidConfig {
+        cargo_package_name: package.name().to_string(),
         manifest_path: package.manifest_path().to_owned(),
         sdk_path: Path::new(&sdk_path).to_owned(),
         ndk_path: Path::new(&ndk_path).to_owned(),
@@ -380,6 +386,7 @@ struct TomlMetadata {
 }
 
 #[derive(Debug, Clone, Deserialize)]
+#[serde(deny_unknown_fields)]
 struct TomlAndroid {
     android_version: Option<u32>,
     target_sdk_version: Option<u32>,
@@ -394,20 +401,23 @@ struct TomlAndroid {
 }
 
 #[derive(Debug, Clone, Deserialize)]
+#[serde(deny_unknown_fields)]
 struct TomlFeature {
     name: String,
     required: Option<bool>,
     version: Option<String>,
 }
 
 #[derive(Debug, Clone, Deserialize)]
+#[serde(deny_unknown_fields)]
 struct TomlPermission {
     name: String,
     max_sdk_version: Option<u32>,
 }
 
 /// Configuration specific to a single cargo target
 #[derive(Debug, Clone, Deserialize)]
+#[serde(deny_unknown_fields)]
 struct TomlAndroidSpecificTarget {
     name: String,
 

examples/advanced/Cargo.toml

@@ -19,7 +19,9 @@ min_sdk_version = 26
 build_targets = [ "armv7-linux-androideabi", "aarch64-linux-android", "i686-linux-android", "x86_64-linux-android" ]
 
 #
-# The following settings can be customized on a per bin/example basis. See multiple_targets example
+# The following value can be customized on a per bin/example basis. See multiple_targets example
+# If a value is not specified for a secondary target, it will inherit the value defined in the `package.metadata.android`
+# section unless otherwise noted.
 #
 
 # The Java package name for your application.