From 2ced6902071996980407157b0812266cb272e6a6 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Mon, 13 Jun 2022 17:25:22 -0300 Subject: [PATCH] docs(config): improve bundle identifier documentation, closes #4203 --- core/tauri-utils/src/config.rs | 4 +++- tooling/cli/schema.json | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/core/tauri-utils/src/config.rs b/core/tauri-utils/src/config.rs index 6dbc36e18..37b82dd9b 100644 --- a/core/tauri-utils/src/config.rs +++ b/core/tauri-utils/src/config.rs @@ -313,7 +313,9 @@ pub struct BundleConfig { pub active: bool, /// The bundle targets, currently supports ["deb", "app", "msi", "appimage", "dmg"] or "all" pub targets: Option, - /// The app's identifier + /// The application identifier in reverse domain name notation (e.g. `com.tauri.example`). + /// This string must be unique across applications since it is used in system configurations like + /// the bundle ID and path to the webview data directory. pub identifier: String, /// The app's icons #[serde(default)] diff --git a/tooling/cli/schema.json b/tooling/cli/schema.json index 4125a8e1a..326cb7768 100644 --- a/tooling/cli/schema.json +++ b/tooling/cli/schema.json @@ -912,7 +912,7 @@ ] }, "identifier": { - "description": "The app's identifier", + "description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory.", "type": "string" }, "icon": {